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

java.lang.Object
  org.kuali.rice.core.api.mo.AbstractDataTransferObject
      org.kuali.rice.krms.api.repository.agenda.AgendaItem

All Implemented Interfaces:

Serializable, Identifiable, Versioned, ModelObjectBasic, ModelObjectComplete, AgendaItemContract

public final class AgendaItem
extends AbstractDataTransferObject
implements AgendaItemContract

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

See Also:

AgendaItemContract, Serialized Form

Nested Class Summary

static class	AgendaItem.Builder This builder is used to construct instances of KRMS Repository AgendaItem.
static class	AgendaItem.Elements A private class which exposes constants which define the XML element names to use when this object is marshalled to XML.

Method Summary

String	getAgendaId() This is the agenda ID for the Agenda associated with this Agenda Item
AgendaItem	getAlways() This is ID of the next AgendaItem to be executed after following any defined true or false actions.
String	getAlwaysId() This is ID of the next AgendaItem 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 AgendaItem.
String	getRuleId() This is ID of the Rule associated with this AgendaItem.
AgendaDefinition	getSubAgenda() This method returns the SubAgenda associated with this AgendaItem.
String	getSubAgendaId() This is ID of the SubAgenda associated with this AgendaItem.
Long	getVersionNumber() Returns the version number for this object.
AgendaItem	getWhenFalse() This method returns the next AgendaItem to be executed if the Rule associated with this AgendaItem evaluates to false.
String	getWhenFalseId() This is ID of the next AgendaItem to be executed if the Rule associated AgendaItem evaluates to false.
AgendaItem	getWhenTrue() This method returns the next AgendaItem to be executed if the Rule associated with this AgendaItem evaluates to true.
String	getWhenTrueId() This is ID of the next AgendaItem to be executed if the Rule associated AgendaItem evaluates to true.

Methods inherited from class org.kuali.rice.core.api.mo.AbstractDataTransferObject

afterUnmarshal, beforeUnmarshal, equals, hashCode, 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: AgendaItemContract

This is the agenda ID for the Agenda associated with this Agenda Item

It is the agenda ID for the Agenda object associated with this Agenda Item.

Specified by:

getAgendaId in interface AgendaItemContract

Returns:

ID for AgendaItem

getRuleId

public String getRuleId()

Description copied from interface: AgendaItemContract

This is ID of the Rule associated with this AgendaItem.

Each AgendaItem has either a Rule or a SubAgenda associated with it, but not both.

Specified by:

getRuleId in interface AgendaItemContract

Returns:

ID of the Rule associated with the AgendaItem

getSubAgendaId

public String getSubAgendaId()

Description copied from interface: AgendaItemContract

This is ID of the SubAgenda associated with this AgendaItem.

Each AgendaItem has either a Rule or a SubAgenda associated with it, but not both.

Specified by:

getSubAgendaId in interface AgendaItemContract

Returns:

ID of the SubAgenda associated with the AgendaItem

getWhenTrueId

public String getWhenTrueId()

Description copied from interface: AgendaItemContract

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

Specified by:

getWhenTrueId in interface AgendaItemContract

Returns:

ID of the next AgendaItem

getWhenFalseId

public String getWhenFalseId()

Description copied from interface: AgendaItemContract

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

Specified by:

getWhenFalseId in interface AgendaItemContract

Returns:

ID of the next AgendaItem

getAlwaysId

public String getAlwaysId()

Description copied from interface: AgendaItemContract

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

Specified by:

getAlwaysId in interface AgendaItemContract

Returns:

ID of the next AgendaItem

getRule

public RuleDefinition getRule()

Description copied from interface: AgendaItemContract

This method returns the Rule associated with this AgendaItem.

Specified by:

getRule in interface AgendaItemContract

Returns:

an immutable representation of the Rule

getSubAgenda

public AgendaDefinition getSubAgenda()

Description copied from interface: AgendaItemContract

This method returns the SubAgenda associated with this AgendaItem.

Specified by:

getSubAgenda in interface AgendaItemContract

Returns:

an immutable representation of the SubAgenda

getWhenTrue

public AgendaItem getWhenTrue()

Description copied from interface: AgendaItemContract

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

Specified by:

getWhenTrue in interface AgendaItemContract

Returns:

an immutable representation of the next AgendaItem

getWhenFalse

public AgendaItem getWhenFalse()

Description copied from interface: AgendaItemContract

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

Specified by:

getWhenFalse in interface AgendaItemContract

Returns:

an immutable representation of the next AgendaItem

getAlways

public AgendaItem getAlways()

Description copied from interface: AgendaItemContract

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

Specified by:

getAlways in interface AgendaItemContract

Returns:

an immutable representation of the next AgendaItem

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