org.kuali.rice.kew.api.peopleflow

Class PeopleFlowMember

java.lang.Object

org.kuali.rice.core.api.mo.AbstractDataTransferObject

org.kuali.rice.kew.api.peopleflow.PeopleFlowMember

All Implemented Interfaces:

Serializable, ModelObjectBasic, ModelObjectComplete, PeopleFlowMemberContract

public final class PeopleFlowMember
extends AbstractDataTransferObject
implements PeopleFlowMemberContract

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PeopleFlowMember.Builder A builder which can be used to construct PeopleFlowMember instances.

Method Summary

Methods

Modifier and Type	Method and Description
ActionRequestPolicy	getActionRequestPolicy() Returns the action request policy to use for this people flow member.
List<PeopleFlowDelegate>	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.
String	getMemberId()
MemberType	getMemberType()
int	getPriority()
String	getResponsibilityId() Returns the responsibility id of this member.

Methods inherited from class org.kuali.rice.core.api.mo.AbstractDataTransferObject

afterUnmarshal, beforeUnmarshal, equals, equalsExcludeFields, getDefaultHashCodeEqualsExcludeFields, hashCode, hashCodeExcludeFields, toString

Methods inherited from class java.lang.Object

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

Method Detail

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.

getMemberType

public MemberType getMemberType()

Specified by:

getMemberType in interface PeopleFlowMemberContract

Returns:

the MemberType of this member. Never null.

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

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

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.

getDelegates

public List<PeopleFlowDelegate> 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

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