org.kuali.rice.kew.api.peopleflow
Class PeopleFlowDefinition

java.lang.Object
  org.kuali.rice.core.api.mo.AbstractDataTransferObject
      org.kuali.rice.kew.api.peopleflow.PeopleFlowDefinition

All Implemented Interfaces:

Serializable, Inactivatable, Identifiable, Versioned, ModelObjectBasic, ModelObjectComplete, PeopleFlowContract

public final class PeopleFlowDefinition
extends AbstractDataTransferObject
implements PeopleFlowContract

See Also:

Serialized Form

Nested Class Summary

static class

PeopleFlowDefinition.Builder A builder which can be used to construct PeopleFlowDefinition instances.

Method Summary

Map<String,String>	getAttributes()
String	getDescription()
String	getId() The unique identifier for an object.
List<PeopleFlowMember>	getMembers() Returns the list of members for this flow, sorted from lowest to highest priority number.
String	getName()
String	getNamespaceCode()
String	getTypeId()
Long	getVersionNumber() Returns the version number for this object.
boolean	isActive() The active indicator for an object.

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

getName

public String getName()

Specified by:

getName in interface PeopleFlowContract

Returns:

the name for this PeopleFlowContract. Will never be null.

getAttributes

public Map<String,String> getAttributes()

Specified by:

getAttributes in interface PeopleFlowContract

Returns:

the attributes for this PeopleFlowContract. Will never return null.

getNamespaceCode

public String getNamespaceCode()

Specified by:

getNamespaceCode in interface PeopleFlowContract

Returns:

the namespace for this PeopleFlowContract. Will never be null.

getTypeId

public String getTypeId()

Specified by:

getTypeId in interface PeopleFlowContract

Returns:

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

getDescription

public String getDescription()

Specified by:

getDescription in interface PeopleFlowContract

Returns:

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

getMembers

public List<PeopleFlowMember> getMembers()

Description copied from interface: PeopleFlowContract

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

Specified by:

getMembers in interface PeopleFlowContract

Returns:

the PeopleFlowMemberContracts for this PeopleFlowContract. Will never return null.

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

isActive

public boolean isActive()

Description copied from interface: Inactivatable

The active indicator for an object.

Specified by:

isActive in interface Inactivatable

Returns:

true if active false if not.

getVersionNumber

public Long getVersionNumber()

Description copied from interface: Versioned

Returns the version number for this object. In general, this value should only be null if the object has not yet been stored to a persistent data store. This version number is generally used for the purposes of optimistic locking.

Specified by:

getVersionNumber in interface Versioned

Returns:

the version number, or null if one has not been assigned yet