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

Interface AgendaDefinitionContract

All Superinterfaces:
org.kuali.rice.core.api.mo.common.Identifiable, org.kuali.rice.core.api.mo.common.active.Inactivatable, org.kuali.rice.core.api.mo.common.Versioned
All Known Implementing Classes:
AgendaDefinition, AgendaDefinition.Builder
public interface AgendaDefinitionContract extends org.kuali.rice.core.api.mo.common.Identifiable, org.kuali.rice.core.api.mo.common.active.Inactivatable, org.kuali.rice.core.api.mo.common.Versioned
Agenda Definition Contract
See Also:

  • Method Summary

    Modifier and Type
    Method
    Description
    Map<String,String>
    getAttributes()
    This method returns a 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
    getName()
    Returns the name of the Agenda.
    String
    getTypeId()
    Returns the KRMS type id of the Agenda.

    Methods inherited from interface org.kuali.rice.core.api.mo.common.Identifiable

    getId

    Methods inherited from interface org.kuali.rice.core.api.mo.common.active.Inactivatable

    isActive

    Methods inherited from interface org.kuali.rice.core.api.mo.common.Versioned

    getVersionNumber

  • Method Details

    • getName

      String getName()
      Returns the name of the Agenda.
      Returns:
      the name of the Agenda

    • getTypeId

      String getTypeId()
      Returns the KRMS type id of the Agenda.
      Returns:
      id for KRMS type related of the agenda

    • getContextId

      String getContextId()
      Returns the context id of the Agenda.
      Returns:
      id for context relative to the agenda

    • getFirstItemId

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

    • getAttributes

      Map<String,String> getAttributes()
      This method returns a list of custom/remote attributes associated with the agenda.
      Returns:
      a list of custom/remote attribute of the agenda.