org.kuali.rice.krms.api.repository.action

Class ActionDefinition

java.lang.Object

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

org.kuali.rice.krms.api.repository.action.ActionDefinition

All Implemented Interfaces:

Serializable, Identifiable, Versioned, ModelObjectBasic, ModelObjectComplete, ActionDefinitionContract

public final class ActionDefinition
extends AbstractDataTransferObject
implements ActionDefinitionContract

Concrete model object implementation of KRMS Repository Action immutable. Instances of Action can be (un)marshalled to and from XML.

Author:

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

See Also:

Action, ActionDefinitionContract, Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ActionDefinition.Builder This builder is used to construct instances of KRMS Repository Action.
static class	ActionDefinition.Cache
static class	ActionDefinition.Elements A private class which exposes constants which define the XML element names to use when this object is marshalled to XML.

Method Summary

Methods

Modifier and Type	Method and Description
Map<String,String>	getAttributes() Returns the internal representation of the set of attributes associated with the Action.
String	getDescription() Returns the description for what the parameter is used for.
String	getId() The unique identifier for an object.
String	getName() Returns the name of the Action
String	getNamespace() Returns the namespace of the Action
String	getRuleId() Returns the id of the rule associated with the action
Integer	getSequenceNumber() Returns the sequence number of the action
String	getTypeId() Returns the KrmsType of the Action
Long	getVersionNumber() Returns the version number for this 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

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

getName

public String getName()

Description copied from interface: ActionDefinitionContract

Returns the name of the Action

name - the name of the Action

Specified by:

getName in interface ActionDefinitionContract

Returns:

the name of the Action

getNamespace

public String getNamespace()

Description copied from interface: ActionDefinitionContract

Returns the namespace of the Action

The namespace of the Action

Specified by:

getNamespace in interface ActionDefinitionContract

Returns:

the namespace of the Action

getDescription

public String getDescription()

Description copied from interface: ActionDefinitionContract

Returns the description for what the parameter is used for. This can be null or a blank string.

Specified by:

getDescription in interface ActionDefinitionContract

Returns:

the description of the Action

getTypeId

public String getTypeId()

Description copied from interface: ActionDefinitionContract

Returns the KrmsType of the Action

Specified by:

getTypeId in interface ActionDefinitionContract

Returns:

id for KRMS type related of the Action

getRuleId

public String getRuleId()

Description copied from interface: ActionDefinitionContract

Returns the id of the rule associated with the action

Specified by:

getRuleId in interface ActionDefinitionContract

Returns:

id for the Rule associated with the action.

getSequenceNumber

public Integer getSequenceNumber()

Description copied from interface: ActionDefinitionContract

Returns the sequence number of the action

Specified by:

getSequenceNumber in interface ActionDefinitionContract

Returns:

sequence number of the action.

getAttributes

public Map<String,String> getAttributes()

Returns the internal representation of the set of attributes associated with the Action. The attributes are represented as name/value pairs.

Specified by:

getAttributes in interface ActionDefinitionContract

Returns:

internal representation of the set of ActionAttribute objects.

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