org.kuali.rice.kew.impl.peopleflow

Class PeopleFlowMemberBo

java.lang.Object

org.kuali.rice.kew.impl.peopleflow.PeopleFlowMemberBo

All Implemented Interfaces:

Serializable, ModelObjectBasic, PeopleFlowMemberContract, BusinessObject

@Entity
public class PeopleFlowMemberBo
extends Object
implements Serializable, PeopleFlowMemberContract, BusinessObject

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
PeopleFlowMemberBo()

Method Summary

Methods

Modifier and Type	Method and Description
static PeopleFlowMemberBo	from(PeopleFlowMember member, PeopleFlowBo peopleFlow)
ActionRequestPolicy	getActionRequestPolicy() Returns the action request policy to use for this people flow member.
String	getActionRequestPolicyCode()
List<PeopleFlowDelegateBo>	getDelegates()
Boolean	getForceAction() Force Action specifies that the requests for this member must be acted on even if the member has already taken that action in the workflow.
GroupEbo	getGroup()
String	getId()
String	getMemberId()
String	getMemberName()
MemberType	getMemberType()
String	getMemberTypeCode()
PeopleFlowBo	getPeopleFlow()
Person	getPerson()
int	getPriority()
String	getResponsibilityId() Returns the responsibility id of this member.
RoleEbo	getRole()
Long	getVersionNumber()
void	refresh() Invoked to refresh business objects related to the parent based on their key field values
void	setActionRequestPolicyCode(String actionRequestPolicyCode)
void	setDelegates(List<PeopleFlowDelegateBo> delegates)
void	setForceAction(Boolean forceAction)
void	setId(String id)
void	setMemberId(String memberId)
void	setMemberName(String memberName)
void	setMemberType(MemberType type)
void	setMemberTypeCode(String memberTypeCode)
void	setPeopleFlow(PeopleFlowBo peopleFlow)
void	setPerson(Person person)
void	setPriority(int priority)
void	setResponsibilityId(String responsibilityId)
void	setVersionNumber(Long versionNumber)
static PeopleFlowMember	to(PeopleFlowMemberBo memberBo)
void	updateRelatedObject()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

toString

Constructor Detail

PeopleFlowMemberBo

public PeopleFlowMemberBo()

Method Detail

getId

public String getId()

setId

public void setId(String id)

getPeopleFlow

public PeopleFlowBo getPeopleFlow()

setPeopleFlow

public void setPeopleFlow(PeopleFlowBo peopleFlow)

getMemberId

public String getMemberId()

Specified by:

getMemberId in interface PeopleFlowMemberContract

Returns:

the id of the member. This will key in to different types depending on the MemberType of the instance.

getMemberTypeCode

public String getMemberTypeCode()

setMemberTypeCode

public void setMemberTypeCode(String memberTypeCode)

getActionRequestPolicyCode

public String getActionRequestPolicyCode()

setActionRequestPolicyCode

public void setActionRequestPolicyCode(String actionRequestPolicyCode)

getResponsibilityId

public String getResponsibilityId()

Description copied from interface: PeopleFlowMemberContract

Returns the responsibility id of this member. This is a unique id which KEW can use to help identify and track the responsibility represented by this people flow member. It will be associated with any action requests that are generated from this people flow membership.

Specified by:

getResponsibilityId in interface PeopleFlowMemberContract

Returns:

the responsibility id for this people flow membership

setResponsibilityId

public void setResponsibilityId(String responsibilityId)

getPriority

public int getPriority()

Specified by:

getPriority in interface PeopleFlowMemberContract

Returns:

the priority of the member. This is equivalent to the sequential stop in the PeopleFlowDefinition, which means lower integer value equates to higher priority. The minimum priority is 1.

setPriority

public void setPriority(int priority)

getVersionNumber

public Long getVersionNumber()

setVersionNumber

public void setVersionNumber(Long versionNumber)

getMemberName

public String getMemberName()

setPerson

public void setPerson(Person person)

getDelegates

public List<PeopleFlowDelegateBo> getDelegates()

Specified by:

getDelegates in interface PeopleFlowMemberContract

Returns:

the list of delegates for this member. Should never be null but may be an empty list in the case where this member has no delegates

setDelegates

public void setDelegates(List<PeopleFlowDelegateBo> delegates)

getForceAction

public Boolean getForceAction()

Description copied from interface: PeopleFlowMemberContract

Force Action specifies that the requests for this member must be acted on even if the member has already taken that action in the workflow.

Specified by:

getForceAction in interface PeopleFlowMemberContract

Returns:

true if Force Action is specified

setForceAction

public void setForceAction(Boolean forceAction)

getPerson

public Person getPerson()

getGroup

public GroupEbo getGroup()

getRole

public RoleEbo getRole()

setMemberName

public void setMemberName(String memberName)
                   throws InstantiationException,
                          IllegalAccessException

Throws:

InstantiationException

IllegalAccessException

setMemberId

public void setMemberId(String memberId)

updateRelatedObject

public void updateRelatedObject()

getMemberType

public MemberType getMemberType()

Specified by:

getMemberType in interface PeopleFlowMemberContract

Returns:

the MemberType of this member. Never null.

setMemberType

public void setMemberType(MemberType type)

getActionRequestPolicy

public ActionRequestPolicy getActionRequestPolicy()

Description copied from interface: PeopleFlowMemberContract

Returns the action request policy to use for this people flow member. This value is only applicable in the case where the MemberType is ROLE. If the member type is anything else, this value will not be considered and should ideally be set to null

Specified by:

getActionRequestPolicy in interface PeopleFlowMemberContract

Returns:

the action request policy to use for this people flow member if it is a role member, null if this member has no request policy

to

public static PeopleFlowMember to(PeopleFlowMemberBo memberBo)

from

public static PeopleFlowMemberBo from(PeopleFlowMember member,
                      PeopleFlowBo peopleFlow)

refresh

public void refresh()

Description copied from interface: BusinessObject

Invoked to refresh business objects related to the parent based on their key field values

During processing (for example accepting user input) the field values that participate in relationships can become out of sync with the related business objects (for example: suppose our business object has a property name bookId with a related object of type Book that contains the id property. If the user changes the value for the bookId property, our id property on the related book and the associated information is still pointing to the previous book id). This method is invoked to indicate the related objects should be refreshed based on their related keys. For @{link PersistableBusinessObject} implementations, most refreshes can be handled by the ORM tool

Specified by:

refresh in interface BusinessObject