org.kuali.rice.krms.impl.repository

Class AgendaItemBo

java.lang.Object

org.kuali.rice.krms.impl.repository.AgendaItemBo

All Implemented Interfaces:

Serializable, Identifiable, Versioned, AgendaItemDefinitionContract

@Entity
public class AgendaItemBo
extends Object
implements AgendaItemDefinitionContract, Versioned, Serializable

Agenda Item business object

Author:

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

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	AGENDA_ITEM_SEQ_NAME
static String	COPY_OF_TEXT

Constructor Summary

Constructors

Constructor and Description
AgendaItemBo()

Method Summary

Methods

Modifier and Type	Method and Description
AgendaItemBo	copyAgendaItem(AgendaBo copiedAgenda, Map<String,RuleBo> oldRuleIdToNew, Map<String,AgendaItemBo> oldAgendaItemIdToNew, List<AgendaItemBo> copiedAgendaItems, String dts) Returns a copy of this AgendaItem
String	getAgendaId() Returns the agenda id to which the agenda item belongs.
AgendaItemBo	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.
List<AgendaItemBo>	getAlwaysList()
String	getId() The unique identifier for an object.
RuleBo	getRule() This method returns the Rule associated with this AgendaItemDefinition.
String	getRuleId() Returns the rule id associated with the agenda item.
String	getRuleText()
AgendaDefinitionContract	getSubAgenda() This method returns the SubAgenda associated with this AgendaItemDefinition.
String	getSubAgendaId() This is ID of the SubAgenda associated with this AgendaItemDefinition.
String	getUl(AgendaItemBo firstItem)
String	getUlHelper(AgendaItemBo item)
Long	getVersionNumber() Returns the version number for this object.
AgendaItemBo	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.
AgendaItemBo	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.
void	setAgendaId(String agendaId)
void	setAlways(AgendaItemBo always)
void	setAlwaysId(String alwaysId)
void	setId(String id)
void	setRule(RuleBo rule)
void	setRuleId(String ruleId)
void	setSubAgendaId(String subAgendaId)
void	setVersionNumber(Long versionNumber)
void	setWhenFalse(AgendaItemBo whenFalse)
void	setWhenFalseId(String whenFalseId)
void	setWhenTrue(AgendaItemBo whenTrue)
void	setWhenTrueId(String whenTrueId)

Methods inherited from class java.lang.Object

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

Field Detail

COPY_OF_TEXT

public static final String COPY_OF_TEXT

See Also:

Constant Field Values

AGENDA_ITEM_SEQ_NAME

public static final String AGENDA_ITEM_SEQ_NAME

See Also:

Constant Field Values

Constructor Detail

AgendaItemBo

public AgendaItemBo()

Method Detail

getUl

public String getUl(AgendaItemBo firstItem)

getUlHelper

public String getUlHelper(AgendaItemBo item)

getRuleText

public String getRuleText()

getAlwaysList

public List<AgendaItemBo> getAlwaysList()

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)

Parameters:

id - the id to set

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:

the agendaId

setAgendaId

public void setAgendaId(String agendaId)

Parameters:

agendaId - the agendaId to set

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:

the ruleId

setRuleId

public void setRuleId(String ruleId)

Parameters:

ruleId - the ruleId to set

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:

the subAgendaId

setSubAgendaId

public void setSubAgendaId(String subAgendaId)

Parameters:

subAgendaId - the subAgendaId to set

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:

the whenTrueId

setWhenTrueId

public void setWhenTrueId(String whenTrueId)

Parameters:

whenTrueId - the whenTrueId to set

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:

the whenFalseId

setWhenFalseId

public void setWhenFalseId(String whenFalseId)

Parameters:

whenFalseId - the whenFalseId to set

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:

the alwaysId

setAlwaysId

public void setAlwaysId(String alwaysId)

Parameters:

alwaysId - the alwaysId to set

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)

getWhenTrue

public AgendaItemBo 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:

the whenTrue

setWhenTrue

public void setWhenTrue(AgendaItemBo whenTrue)

Parameters:

whenTrue - the whenTrue to set

getWhenFalse

public AgendaItemBo 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:

the whenFalse

setWhenFalse

public void setWhenFalse(AgendaItemBo whenFalse)

Parameters:

whenFalse - the whenFalse to set

getAlways

public AgendaItemBo 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:

the always

setAlways

public void setAlways(AgendaItemBo always)

Parameters:

always - the always to set

getRule

public RuleBo getRule()

Description copied from interface: AgendaItemDefinitionContract

This method returns the Rule associated with this AgendaItemDefinition.

Specified by:

getRule in interface AgendaItemDefinitionContract

Returns:

the rule

getSubAgenda

public AgendaDefinitionContract 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

setRule

public void setRule(RuleBo rule)

Parameters:

rule - the rule to set

copyAgendaItem

public AgendaItemBo copyAgendaItem(AgendaBo copiedAgenda,
                          Map<String,RuleBo> oldRuleIdToNew,
                          Map<String,AgendaItemBo> oldAgendaItemIdToNew,
                          List<AgendaItemBo> copiedAgendaItems,
                          String dts)

Returns a copy of this AgendaItem

Parameters:

copiedAgenda - the new Agenda that the copied AgendiaItem will be associated with

oldRuleIdToNew - Map mapping of old rule id to the new RuleBo

dts - DateTimeStamp to append to the copied AgendaItem name

Returns:

AgendaItemBo copy of this AgendaItem with new id and name