org.kuali.rice.krms.api.repository.agenda

Class AgendaItemDefinition

java.lang.Object

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

org.kuali.rice.krms.api.repository.agenda.AgendaItemDefinition

All Implemented Interfaces:

Serializable, Identifiable, Versioned, ModelObjectBasic, ModelObjectComplete, AgendaItemDefinitionContract

public final class AgendaItemDefinition
extends AbstractDataTransferObject
implements AgendaItemDefinitionContract

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

See Also:

AgendaItemDefinitionContract, Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AgendaItemDefinition.Builder This builder is used to construct instances of KRMS Repository AgendaItemDefinition.
static class	AgendaItemDefinition.Cache
static class	AgendaItemDefinition.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
String	getAgendaId() Returns the agenda id to which the agenda item belongs.
AgendaItemDefinition	getAlways() This is ID of the next AgendaItemDefinition to be executed after following any defined true or false actions.
String	getAlwaysId() This is ID of the next AgendaItemDefinition to be executed after following any defined true or false actions.
String	getId() The unique identifier for an object.
RuleDefinition	getRule() This method returns the Rule associated with this AgendaItemDefinition.
String	getRuleId() Returns the rule id associated with the agenda item.
AgendaDefinition	getSubAgenda() This method returns the SubAgenda associated with this AgendaItemDefinition.
String	getSubAgendaId() This is ID of the SubAgenda associated with this AgendaItemDefinition.
Long	getVersionNumber() Returns the version number for this object.
AgendaItemDefinition	getWhenFalse() This method returns the next AgendaItemDefinition to be executed if the Rule associated with this AgendaItemDefinition evaluates to false.
String	getWhenFalseId() This is ID of the next AgendaItemDefinition to be executed if the Rule associated AgendaItemDefinition evaluates to false.
AgendaItemDefinition	getWhenTrue() This method returns the next AgendaItemDefinition to be executed if the Rule associated with this AgendaItemDefinition evaluates to true.
String	getWhenTrueId() This is ID of the next AgendaItemDefinition to be executed if the Rule associated AgendaItemDefinition evaluates to true.

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

getAgendaId

public String getAgendaId()

Description copied from interface: AgendaItemDefinitionContract

Returns the agenda id to which the agenda item belongs.

Specified by:

getAgendaId in interface AgendaItemDefinitionContract

Returns:

id for the agenda associated with the agenda item

getRuleId

public String getRuleId()

Description copied from interface: AgendaItemDefinitionContract

Returns the rule id associated with the agenda item.

Specified by:

getRuleId in interface AgendaItemDefinitionContract

Returns:

ID of the Rule associated with the agenda item

getSubAgendaId

public String getSubAgendaId()

Description copied from interface: AgendaItemDefinitionContract

This is ID of the SubAgenda associated with this AgendaItemDefinition. Each AgendaItemDefinition has either a Rule or a SubAgenda associated with it, but not both.

Specified by:

getSubAgendaId in interface AgendaItemDefinitionContract

Returns:

ID of the SubAgenda associated with the AgendaItemDefinition

getWhenTrueId

public String getWhenTrueId()

Description copied from interface: AgendaItemDefinitionContract

This is ID of the next AgendaItemDefinition to be executed if the Rule associated AgendaItemDefinition evaluates to true.

Specified by:

getWhenTrueId in interface AgendaItemDefinitionContract

Returns:

ID of the next AgendaItemDefinition

getWhenFalseId

public String getWhenFalseId()

Description copied from interface: AgendaItemDefinitionContract

This is ID of the next AgendaItemDefinition to be executed if the Rule associated AgendaItemDefinition evaluates to false.

Specified by:

getWhenFalseId in interface AgendaItemDefinitionContract

Returns:

ID of the next AgendaItemDefinition

getAlwaysId

public String getAlwaysId()

Description copied from interface: AgendaItemDefinitionContract

This is ID of the next AgendaItemDefinition to be executed after following any defined true or false actions.

Specified by:

getAlwaysId in interface AgendaItemDefinitionContract

Returns:

ID of the next AgendaItemDefinition

getRule

public RuleDefinition getRule()

Description copied from interface: AgendaItemDefinitionContract

This method returns the Rule associated with this AgendaItemDefinition.

Specified by:

getRule in interface AgendaItemDefinitionContract

Returns:

an immutable representation of the Rule

getSubAgenda

public AgendaDefinition getSubAgenda()

Description copied from interface: AgendaItemDefinitionContract

This method returns the SubAgenda associated with this AgendaItemDefinition.

Specified by:

getSubAgenda in interface AgendaItemDefinitionContract

Returns:

an immutable representation of the SubAgenda

getWhenTrue

public AgendaItemDefinition getWhenTrue()

Description copied from interface: AgendaItemDefinitionContract

This method returns the next AgendaItemDefinition to be executed if the Rule associated with this AgendaItemDefinition evaluates to true.

Specified by:

getWhenTrue in interface AgendaItemDefinitionContract

Returns:

an immutable representation of the next AgendaItemDefinition

getWhenFalse

public AgendaItemDefinition getWhenFalse()

Description copied from interface: AgendaItemDefinitionContract

This method returns the next AgendaItemDefinition to be executed if the Rule associated with this AgendaItemDefinition evaluates to false.

Specified by:

getWhenFalse in interface AgendaItemDefinitionContract

Returns:

an immutable representation of the next AgendaItemDefinition

getAlways

public AgendaItemDefinition getAlways()

Description copied from interface: AgendaItemDefinitionContract

This is ID of the next AgendaItemDefinition to be executed after following any defined true or false actions.

Specified by:

getAlways in interface AgendaItemDefinitionContract

Returns:

an immutable representation of the next AgendaItemDefinition

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