org.kuali.rice.krms.impl.repository

Class AgendaBo

java.lang.Object

org.kuali.rice.krms.impl.repository.AgendaBo

All Implemented Interfaces:

Serializable, Inactivatable, Identifiable, Versioned, AgendaDefinitionContract

@Entity
public class AgendaBo
extends Object
implements AgendaDefinitionContract, Serializable

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	AGENDA_SEQ_NAME

Constructor Summary

Constructors

Constructor and Description
AgendaBo()

Method Summary

Methods

Modifier and Type	Method and Description
AgendaBo	copyAgenda(String newAgendaName, String dateTimeStamp) Returns of copy of this agenda, with the given newAgendaName and new ids.
boolean	getActive()
AgendaBo	getAgenda()
Set<AgendaAttributeBo>	getAttributeBos()
Map<String,String>	getAttributes() This method returns a list of custom/remote attributes associated with the agenda.
ContextBo	getContext()
String	getContextId() Returns the context id of the Agenda.
AgendaItemBo	getFirstItem()
String	getFirstItemId() Returns the fist agenda item id to be executed in the Agenda.
String	getId() The unique identifier for an object.
List<AgendaItemBo>	getItems()
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.
void	setActive(boolean active)
void	setAttributeBos(Set<AgendaAttributeBo> attributeBos)
void	setAttributes(Map<String,String> attributes)
void	setContext(ContextBo context)
void	setContextId(String contextId)
void	setFirstItem(AgendaItemBo firstItem)
void	setFirstItemId(String firstItemId)
void	setId(String id)
void	setItems(List<AgendaItemBo> items)
void	setName(String name)
void	setTypeId(String typeId)
void	setVersionNumber(Long versionNumber)
static AgendaDefinition	to(AgendaBo 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

Field Detail

AGENDA_SEQ_NAME

public static final String AGENDA_SEQ_NAME

See Also:

Constant Field Values

Constructor Detail

AgendaBo

public AgendaBo()

Method Detail

getAgenda

public AgendaBo getAgenda()

getAttributes

public Map<String,String> getAttributes()

Description copied from interface: AgendaDefinitionContract

This method returns a list of custom/remote attributes associated with the agenda.

Specified by:

getAttributes in interface AgendaDefinitionContract

Returns:

a list of custom/remote attribute of the agenda.

setAttributes

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

copyAgenda

public AgendaBo copyAgenda(String newAgendaName,
                  String dateTimeStamp)

Returns of copy of this agenda, with the given newAgendaName and new ids.

Parameters:

newAgendaName - name of the newly copied AgendaBo

dateTimeStamp - to append to the names of objects

Returns:

AgendaBo copy of this Agenda with new ids and name

to

public static AgendaDefinition to(AgendaBo bo)

Converts a mutable bo to it's immutable counterpart

Parameters:

bo - the mutable business object

Returns:

the immutable object AgendaDefinition

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)

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

setName

public void setName(String name)

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

setTypeId

public void setTypeId(String typeId)

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

setContextId

public void setContextId(String contextId)

getActive

public boolean getActive()

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.

setActive

public void setActive(boolean active)

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.

setFirstItemId

public void setFirstItemId(String firstItemId)

getFirstItem

public AgendaItemBo getFirstItem()

setFirstItem

public void setFirstItem(AgendaItemBo firstItem)

getAttributeBos

public Set<AgendaAttributeBo> getAttributeBos()

setAttributeBos

public void setAttributeBos(Set<AgendaAttributeBo> attributeBos)

getItems

public List<AgendaItemBo> getItems()

setItems

public void setItems(List<AgendaItemBo> items)

getContext

public ContextBo getContext()

setContext

public void setContext(ContextBo context)

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)