org.kuali.rice.kew.rule
Class RuleResponsibilityBo

java.lang.Object
  org.kuali.rice.krad.bo.BusinessObjectBase
      org.kuali.rice.krad.bo.PersistableBusinessObjectBase
          org.kuali.rice.kew.rule.RuleResponsibilityBo

All Implemented Interfaces:

Serializable, org.apache.ojb.broker.PersistenceBrokerAware, GloballyUnique, Identifiable, Versioned, ModelObjectBasic, RuleResponsibilityContract, BusinessObject, PersistableBusinessObject

Direct Known Subclasses:

GroupRuleResponsibility, PersonRuleResponsibility, RoleRuleResponsibility, WebRuleResponsibility

@Entity
public class RuleResponsibilityBo
extends PersistableBusinessObjectBase
implements RuleResponsibilityContract

A model bean representing the responsibility of a user, workgroup, or role to perform some action on a document. Used by the rule system to identify the appropriate responsibile parties to generate ActionRequestValues to.

Author:

Kuali Rice Team (rice.collab@kuali.org)

See Also:

Serialized Form

Field Summary

Fields inherited from class org.kuali.rice.krad.bo.PersistableBusinessObjectBase

extension, versionNumber

Constructor Summary

RuleResponsibilityBo()

Method Summary

Object	copy(boolean preserveKeys)
boolean	equals(Object o)
String	getActionRequestedCd() code for the Action Requested
String	getActionRequestedDisplayValue()
String	getApprovePolicy() approval policy for the RuleResponsibility
RuleDelegationBo	getDelegationRule(int index)
List<RuleDelegationBo>	getDelegationRules() list of RuleDelegations for the RuleResponsibility
Group	getGroup()
String	getGroupId() unique id of the Group for the RuleResponsibility
String	getId() The unique identifier for an object.
Principal	getPrincipal()
String	getPrincipalId() unique id of the Principal for the RuleResponsibility
Integer	getPriority() integer representation of the priority of the RuleResponsibility
Recipient	getRecipient() Convenience method to return the Recipient for this RuleResponsibility
String	getResolvedRoleName()
String	getResponsibilityId() Unique Id for Responsibility.
String	getRole()
String	getRoleAttributeName()
String	getRoleName() unique name of the Role for the RuleResponsibility
RuleBaseValues	getRuleBaseValues()
String	getRuleBaseValuesId()
String	getRuleResponsibilityName()
String	getRuleResponsibilityType()
String	getRuleResponsibilityTypeDisplayValue()
int	hashCode()
boolean	isUsingGroup() determines if the RuleResponsibiltity is using a kim Group
boolean	isUsingPrincipal() determines if the RuleResponsibiltity is using a kim Principal
boolean	isUsingRole() determines if the RuleResponsibiltity is using a kim Role
RoleAttribute	resolveRoleAttribute()
void	setActionRequestedCd(String actionRequestedCd)
void	setApprovePolicy(String approvePolicy)
void	setId(String ruleResponsibilityId)
void	setPriority(Integer priority)
void	setResponsibilityId(String responsibilityId)
void	setRuleBaseValues(RuleBaseValues ruleBaseValues)
void	setRuleBaseValuesId(String ruleBaseValuesId)
void	setRuleResponsibilityName(String ruleResponsibilityName)
void	setRuleResponsibilityType(String ruleResponsibilityType)
static RuleResponsibility	to(RuleResponsibilityBo bo)

Methods inherited from class org.kuali.rice.krad.bo.PersistableBusinessObjectBase

afterDelete, afterInsert, afterLookup, afterUpdate, beforeDelete, beforeInsert, beforeUpdate, buildListOfDeletionAwareLists, getExtension, getObjectId, getPersistenceService, getPersistenceStructureService, getVersionNumber, isNewCollectionRecord, linkEditableUserFields, postLoad, postPersist, postRemove, postUpdate, prePersist, preRemove, preUpdate, refresh, refreshNonUpdateableReferences, refreshReferenceObject, setExtension, setNewCollectionRecord, setObjectId, setVersionNumber

Methods inherited from class org.kuali.rice.krad.bo.BusinessObjectBase

toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.kuali.rice.core.api.mo.common.GloballyUnique

getObjectId

Methods inherited from interface org.kuali.rice.core.api.mo.common.Versioned

getVersionNumber

Methods inherited from interface org.kuali.rice.core.api.mo.ModelObjectBasic

toString

Constructor Detail

RuleResponsibilityBo

public RuleResponsibilityBo()

Method Detail

getPrincipal

public Principal getPrincipal()

getGroup

public Group getGroup()

getRole

public String getRole()

getResolvedRoleName

public String getResolvedRoleName()

getRoleAttributeName

public String getRoleAttributeName()

resolveRoleAttribute

public RoleAttribute resolveRoleAttribute()

isUsingRole

public boolean isUsingRole()

Description copied from interface: RuleResponsibilityContract

determines if the RuleResponsibiltity is using a kim Role

Specified by:

isUsingRole in interface RuleResponsibilityContract

Returns:

boolean value representing if the RuleResponsibility is using a Role

isUsingPrincipal

public boolean isUsingPrincipal()

Description copied from interface: RuleResponsibilityContract

determines if the RuleResponsibiltity is using a kim Principal

Specified by:

isUsingPrincipal in interface RuleResponsibilityContract

Returns:

boolean value representing if the RuleResponsibility is using a Principal

isUsingGroup

public boolean isUsingGroup()

Description copied from interface: RuleResponsibilityContract

determines if the RuleResponsibiltity is using a kim Group

Specified by:

isUsingGroup in interface RuleResponsibilityContract

Returns:

boolean value representing if the RuleResponsibility is using a Group

getRuleBaseValuesId

public String getRuleBaseValuesId()

setRuleBaseValuesId

public void setRuleBaseValuesId(String ruleBaseValuesId)

getRuleBaseValues

public RuleBaseValues getRuleBaseValues()

setRuleBaseValues

public void setRuleBaseValues(RuleBaseValues ruleBaseValues)

getActionRequestedCd

public String getActionRequestedCd()

Description copied from interface: RuleResponsibilityContract

code for the Action Requested

This code matches the unique code for an ActionRequest

Specified by:

getActionRequestedCd in interface RuleResponsibilityContract

Returns:

actionRequestedCd

setActionRequestedCd

public void setActionRequestedCd(String actionRequestedCd)

getId

public String getId()

Description copied from interface: Identifiable

The unique identifier for an object. This can be null.

Specified by:

getId in interface Identifiable

Returns:

the id

setId

public void setId(String ruleResponsibilityId)

getPriority

public Integer getPriority()

Description copied from interface: RuleResponsibilityContract

integer representation of the priority of the RuleResponsibility

Specified by:

getPriority in interface RuleResponsibilityContract

Returns:

priority

setPriority

public void setPriority(Integer priority)

getApprovePolicy

public String getApprovePolicy()

Description copied from interface: RuleResponsibilityContract

approval policy for the RuleResponsibility

Specified by:

getApprovePolicy in interface RuleResponsibilityContract

Returns:

approvalPolicy

setApprovePolicy

public void setApprovePolicy(String approvePolicy)

copy

public Object copy(boolean preserveKeys)

getRuleResponsibilityName

public String getRuleResponsibilityName()

setRuleResponsibilityName

public void setRuleResponsibilityName(String ruleResponsibilityName)

getRuleResponsibilityType

public String getRuleResponsibilityType()

setRuleResponsibilityType

public void setRuleResponsibilityType(String ruleResponsibilityType)

getResponsibilityId

public String getResponsibilityId()

Description copied from interface: RuleResponsibilityContract

Unique Id for Responsibility.

This is the unique Id of the Responsibility

Specified by:

getResponsibilityId in interface RuleResponsibilityContract

Returns:

responsibilityId

setResponsibilityId

public void setResponsibilityId(String responsibilityId)

getDelegationRules

public List<RuleDelegationBo> getDelegationRules()

Description copied from interface: RuleResponsibilityContract

list of RuleDelegations for the RuleResponsibility

Specified by:

getDelegationRules in interface RuleResponsibilityContract

Returns:

delegationRules

getDelegationRule

public RuleDelegationBo getDelegationRule(int index)

getActionRequestedDisplayValue

public String getActionRequestedDisplayValue()

getRuleResponsibilityTypeDisplayValue

public String getRuleResponsibilityTypeDisplayValue()

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

See Also:

Object.hashCode()

getGroupId

public String getGroupId()

Description copied from interface: RuleResponsibilityContract

unique id of the Group for the RuleResponsibility

Specified by:

getGroupId in interface RuleResponsibilityContract

Returns:

groupId

getPrincipalId

public String getPrincipalId()

Description copied from interface: RuleResponsibilityContract

unique id of the Principal for the RuleResponsibility

Specified by:

getPrincipalId in interface RuleResponsibilityContract

Returns:

principalId

getRoleName

public String getRoleName()

Description copied from interface: RuleResponsibilityContract

unique name of the Role for the RuleResponsibility

Specified by:

getRoleName in interface RuleResponsibilityContract

Returns:

groupId

getRecipient

public Recipient getRecipient()

Convenience method to return the Recipient for this RuleResponsibility

Returns:

the Recipient for this RuleResponsibility

to

public static RuleResponsibility to(RuleResponsibilityBo bo)