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

Interface ActionDefinitionContract

All Superinterfaces:

Identifiable, Versioned

All Known Implementing Classes:

ActionDefinition, ActionDefinition.Builder

public interface ActionDefinitionContract
extends Identifiable, Versioned

Defines the contract for an ActionDefinition

Author:

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

See Also:

ActionDefinition, Action

Method Summary

Methods

Modifier and Type	Method and Description
Map<String,String>	getAttributes() Returns a set of attributes associated with the Action.
String	getDescription() Returns the description for what the parameter is used for.
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

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

getId

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

getVersionNumber

Method Detail

getName

String getName()

Returns the name of the Action

name - the name of the Action

Returns:

the name of the Action

getNamespace

String getNamespace()

Returns the namespace of the Action

The namespace of the Action

Returns:

the namespace of the Action

getDescription

String getDescription()

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

Returns:

the description of the Action

getTypeId

String getTypeId()

Returns the KrmsType of the Action

Returns:

id for KRMS type related of the Action

getRuleId

String getRuleId()

Returns the id of the rule associated with the action

Returns:

id for the Rule associated with the action.

getSequenceNumber

Integer getSequenceNumber()

Returns the sequence number of the action

Returns:

sequence number of the action.

getAttributes

Map<String,String> getAttributes()

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

Returns:

a set of ActionAttribute objects.