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

Class AgendaDefinition

java.lang.Object

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

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

All Implemented Interfaces:

Serializable, Inactivatable, Identifiable, Versioned, ModelObjectBasic, ModelObjectComplete, AgendaDefinitionContract

public final class AgendaDefinition
extends AbstractDataTransferObject
implements AgendaDefinitionContract

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

See Also:

AgendaDefinitionContract, Serialized Form

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
Map<String,String>	getAttributes() Returns the internal list of custom/remote attributes associated with the agenda.
String	getContextId() Returns the context id of the Agenda.
String	getFirstItemId() Returns the fist agenda item id to be executed in the Agenda.
String	getId() The unique identifier for an object.
String	getName() Returns the name of the Agenda.
String	getTypeId() Returns the KRMS type id of the Agenda.
Long	getVersionNumber() Returns the version number for this object.
boolean	isActive() The active indicator for an 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: AgendaDefinitionContract

Returns the name of the Agenda.

Specified by:

getName in interface AgendaDefinitionContract

Returns:

the name of the Agenda

getTypeId

public String getTypeId()

Description copied from interface: AgendaDefinitionContract

Returns the KRMS type id of the Agenda.

Specified by:

getTypeId in interface AgendaDefinitionContract

Returns:

id for KRMS type related of the agenda

getContextId

public String getContextId()

Description copied from interface: AgendaDefinitionContract

Returns the context id of the Agenda.

Specified by:

getContextId in interface AgendaDefinitionContract

Returns:

id for context relative to the agenda

isActive

public boolean isActive()

Description copied from interface: Inactivatable

The active indicator for an object.

Specified by:

isActive in interface Inactivatable

Returns:

true if active false if not.

getFirstItemId

public String getFirstItemId()

Description copied from interface: AgendaDefinitionContract

Returns the fist agenda item id to be executed in the Agenda. (Also known as the root of the agenda item / rules tree.)

Specified by:

getFirstItemId in interface AgendaDefinitionContract

Returns:

id of the first agenda item id of the agenda.

getAttributes

public Map<String,String> getAttributes()

Returns the internal list of custom/remote attributes associated with the agenda.

Specified by:

getAttributes in interface AgendaDefinitionContract

Returns:

the internal list of custom/remote attribute of the agenda.

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