org.kuali.rice.krms.impl.repository

Class ActionBo

java.lang.Object

org.kuali.rice.krms.impl.repository.ActionBo

All Implemented Interfaces:

Serializable, Identifiable, Versioned, ActionDefinitionContract

@Entity
public class ActionBo
extends Object
implements ActionDefinitionContract, Versioned, Serializable

The Action Business Object is the Action mutable class.

Author:

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

See Also:

ActionDefinition, ActionDefinitionContract, Action, Serialized Form

Constructor Summary

Constructors

Constructor and Description
ActionBo()

Method Summary

Methods

Modifier and Type	Method and Description
static ActionBo	from(ActionDefinition im) Converts a immutable object to it's mutable bo counterpart
List<ActionAttributeBo>	getAttributeBos()
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	getId() The unique identifier for an object.
String	getName() Returns the name of the Action
String	getNamespace() Returns the namespace of the Action
RuleBo	getRule()
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.
void	setAttributeBos(List<ActionAttributeBo> attributeBos)
void	setAttributes(Map<String,String> attributes) Set the Action Attributes
void	setDescription(String description)
void	setId(String id)
void	setName(String name)
void	setNamespace(String namespace)
void	setRule(RuleBo rule)
void	setSequenceNumber(Integer sequenceNumber)
void	setTypeId(String typeId)
void	setVersionNumber(Long versionNumber)
static ActionDefinition	to(ActionBo bo) Converts a mutable bo to it's immutable counterpart

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ActionBo

public ActionBo()

Method Detail

getAttributes

public Map<String,String> getAttributes()

Description copied from interface: ActionDefinitionContract

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

Specified by:

getAttributes in interface ActionDefinitionContract

Returns:

a set of ActionAttribute objects.

setAttributes

public void setAttributes(Map<String,String> attributes)

Set the Action Attributes

Parameters:

attributes - to add to this Action

to

public static ActionDefinition to(ActionBo bo)

Converts a mutable bo to it's immutable counterpart

Parameters:

bo - the mutable business object

Returns:

the immutable object

from

public static ActionBo from(ActionDefinition im)

Converts a immutable object to it's mutable bo counterpart

Parameters:

im - immutable object

Returns:

the mutable bo

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

setId

public void setId(String id)

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

setNamespace

public void setNamespace(String namespace)

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

setName

public void setName(String name)

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

setDescription

public void setDescription(String description)

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

setTypeId

public void setTypeId(String typeId)

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.

getRule

public RuleBo getRule()

setRule

public void setRule(RuleBo rule)

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.

setSequenceNumber

public void setSequenceNumber(Integer sequenceNumber)

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

setVersionNumber

public void setVersionNumber(Long versionNumber)

getAttributeBos

public List<ActionAttributeBo> getAttributeBos()

setAttributeBos

public void setAttributeBos(List<ActionAttributeBo> attributeBos)