Package org.kuali.rice.kew.api.peopleflow

Interface PeopleFlowContract

All Superinterfaces:

org.kuali.rice.core.api.mo.common.Identifiable, org.kuali.rice.core.api.mo.common.active.Inactivatable, org.kuali.rice.core.api.mo.common.Versioned

All Known Implementing Classes:

PeopleFlowDefinition, PeopleFlowDefinition.Builder

public interface PeopleFlowContract
extends org.kuali.rice.core.api.mo.common.Identifiable, org.kuali.rice.core.api.mo.common.active.Inactivatable, org.kuali.rice.core.api.mo.common.Versioned

Contract interface for a PeopleFlowDefinition. A PeopleFlowDefinition is simply a collections of members and their (optional) delegates. Each member of a PeopleFlowDefinition has a priority number assigned to it, which indicates the order in which members should be processed during execution of the flow.

Priority is ordered by the lowest priority number being the "beginning" of the flow. It is possible for one or more members to have the same priority number, in which case they should be processed in parallel.

Members of a flow can be one of either a principal, group, or role which is defined by the PeopleFlowMemberContract.

Author:

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

Method Summary

Modifier and Type	Method	Description
Map<String,String>	getAttributes()
String	getDescription()
List<? extends PeopleFlowMemberContract>	getMembers()	Returns the list of members for this flow, sorted from lowest to highest priority number.
String	getName()
String	getNamespaceCode()
String	getTypeId()

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

getId

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

isActive

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

getVersionNumber

Method Details

getName

String getName()

Returns:

the name for this PeopleFlowContract. Will never be null.

getNamespaceCode

String getNamespaceCode()

Returns:

the namespace for this PeopleFlowContract. Will never be null.

getTypeId

String getTypeId()

Returns:

the type id for this PeopleFlowContract. Will never be null.

getDescription

String getDescription()

Returns:

the name for this PeopleFlowContract. May be null, but not empty.

getMembers

List<? extends PeopleFlowMemberContract> getMembers()

Returns the list of members for this flow, sorted from lowest to highest priority number.

Returns:

the PeopleFlowMemberContracts for this PeopleFlowContract. Will never return null.

getAttributes

Map<String,String> getAttributes()

Returns:

the attributes for this PeopleFlowContract. Will never return null.