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

All Superinterfaces:
Identifiable, Versioned
All Known Implementing Classes:
AgendaItem, AgendaItem.Builder

public interface AgendaItemContract
extends Identifiable, Versioned


Method Summary
 String getAgendaId()
          This is the agenda ID for the Agenda associated with this Agenda Item
 AgendaItemContract 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.
 RuleDefinitionContract getRule()
          This method returns the Rule associated with this AgendaItem.
 String getRuleId()
          This is ID of the Rule associated with this AgendaItem.
 AgendaDefinitionContract getSubAgenda()
          This method returns the SubAgenda associated with this AgendaItem.
 String getSubAgendaId()
          This is ID of the SubAgenda associated with this AgendaItem.
 AgendaItemContract 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.
 AgendaItemContract 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 interface org.kuali.rice.core.api.mo.common.Identifiable
getId
 
Methods inherited from interface org.kuali.rice.core.api.mo.common.Versioned
getVersionNumber
 

Method Detail

getAgendaId

String getAgendaId()
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.

Returns:
ID for AgendaItem

getRuleId

String getRuleId()
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.

Returns:
ID of the Rule associated with the AgendaItem

getSubAgendaId

String getSubAgendaId()
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.

Returns:
ID of the SubAgenda associated with the AgendaItem

getWhenTrueId

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

Returns:
ID of the next AgendaItem

getWhenFalseId

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

Returns:
ID of the next AgendaItem

getAlwaysId

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

Returns:
ID of the next AgendaItem

getRule

RuleDefinitionContract getRule()
This method returns the Rule associated with this AgendaItem.

Returns:
an immutable representation of the Rule

getSubAgenda

AgendaDefinitionContract getSubAgenda()
This method returns the SubAgenda associated with this AgendaItem.

Returns:
an immutable representation of the SubAgenda

getWhenTrue

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

Returns:
an immutable representation of the next AgendaItem

getWhenFalse

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

Returns:
an immutable representation of the next AgendaItem

getAlways

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

Returns:
an immutable representation of the next AgendaItem


Copyright © 2004-2011 The Kuali Foundation. All Rights Reserved.