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

Interface AgendaItemDefinitionContract

All Superinterfaces:
org.kuali.rice.core.api.mo.common.Identifiable, org.kuali.rice.core.api.mo.common.Versioned
All Known Implementing Classes:
AgendaItemDefinition, AgendaItemDefinition.Builder
public interface AgendaItemDefinitionContract extends org.kuali.rice.core.api.mo.common.Identifiable, org.kuali.rice.core.api.mo.common.Versioned
Agenda Item Definition Contract
See Also:

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getAgendaId()
    Returns the agenda id to which the agenda item belongs.
    AgendaItemDefinitionContract
    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.
    RuleDefinitionContract
    getRule()
    This method returns the Rule associated with this AgendaItemDefinition.
    String
    getRuleId()
    Returns the rule id associated with the agenda item.
    AgendaDefinitionContract
    getSubAgenda()
    This method returns the SubAgenda associated with this AgendaItemDefinition.
    String
    getSubAgendaId()
    This is ID of the SubAgenda associated with this AgendaItemDefinition.
    AgendaItemDefinitionContract
    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.
    AgendaItemDefinitionContract
    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.

    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 Details

    • getAgendaId

      String getAgendaId()
      Returns the agenda id to which the agenda item belongs.
      Returns:
      id for the agenda associated with the agenda item

    • getRuleId

      String getRuleId()
      Returns the rule id associated with the agenda item.
      Returns:
      ID of the Rule associated with the agenda item

    • getSubAgendaId

      String getSubAgendaId()
      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.
      Returns:
      ID of the SubAgenda associated with the AgendaItemDefinition

    • getWhenTrueId

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

    • getWhenFalseId

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

    • getAlwaysId

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

    • getRule

      RuleDefinitionContract getRule()
      This method returns the Rule associated with this AgendaItemDefinition.
      Returns:
      an immutable representation of the Rule

    • getSubAgenda

      AgendaDefinitionContract getSubAgenda()
      This method returns the SubAgenda associated with this AgendaItemDefinition.
      Returns:
      an immutable representation of the SubAgenda

    • getWhenTrue

      AgendaItemDefinitionContract getWhenTrue()
      This method returns the next AgendaItemDefinition to be executed if the Rule associated with this AgendaItemDefinition evaluates to true.
      Returns:
      an immutable representation of the next AgendaItemDefinition

    • getWhenFalse

      AgendaItemDefinitionContract getWhenFalse()
      This method returns the next AgendaItemDefinition to be executed if the Rule associated with this AgendaItemDefinition evaluates to false.
      Returns:
      an immutable representation of the next AgendaItemDefinition

    • getAlways

      AgendaItemDefinitionContract getAlways()
      This is ID of the next AgendaItemDefinition to be executed after following any defined true or false actions.
      Returns:
      an immutable representation of the next AgendaItemDefinition