org.kuali.rice.kew.api.peopleflow
Interface PeopleFlowMemberContract

All Known Implementing Classes:

PeopleFlowMember, PeopleFlowMember.Builder

public interface PeopleFlowMemberContract

Interface contract for PeopleFlowDefinition members.

Author:

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

Method Summary

ActionRequestPolicy	getActionRequestPolicy() Returns the action request policy to use for this people flow member.
List<? extends PeopleFlowDelegateContract>	getDelegates()
String	getMemberId()
MemberType	getMemberType()
int	getPriority()
String	getResponsibilityId() Returns the responsibility id of this member.

Method Detail

getMemberId

String getMemberId()

Returns:

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

getMemberType

MemberType getMemberType()

Returns:

the MemberType of this member. Never null.

getActionRequestPolicy

ActionRequestPolicy getActionRequestPolicy()

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

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

getPriority

int getPriority()

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.

getResponsibilityId

String getResponsibilityId()

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.

Returns:

the responsibility id for this people flow membership

getDelegates

List<? extends PeopleFlowDelegateContract> getDelegates()

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