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

Interface PropositionDefinitionContract

All Superinterfaces:
org.kuali.rice.core.api.mo.common.Identifiable, org.kuali.rice.core.api.mo.common.Versioned
All Known Implementing Classes:
PropositionDefinition, PropositionDefinition.Builder
public interface PropositionDefinitionContract extends org.kuali.rice.core.api.mo.common.Identifiable, org.kuali.rice.core.api.mo.common.Versioned
Defines the contract for a PropositionDefinition
Author:
Kuali Rice Team (rice.collab@kuali.org)
See Also:

  • Method Summary

    Modifier and Type
    Method
    Description
    List<? extends PropositionDefinitionContract>
    getCompoundComponents()
    Returns the propositions which are contained in a compound proposition.
    String
    getCompoundOpCode()
    Returns the op code to be used when evaluating compound propositions.
    Integer
    getCompoundSequenceNumber()
    Returns the sequence number used to order the compound propositions Note: this value is set by the service
    String
    getDescription()
    Returns the description text for the KRMS proposition
    List<? extends PropositionParameterContract>
    getParameters()
    Returns the parameter list of the proposition.
    String
    getPropositionTypeCode()
    There are three main types of Propositions: Compound Propositions - a proposition consisting of other propositions and a boolean algebra operator (AND, OR) defining how to evaluate those propositions.
    String
    getRuleId()
    TReturns the ID of the rule this proposition belongs to.
    String
    getTypeId()
    Returns the id of Proposition KrmsType of the proposition.

    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

    • getDescription

      String getDescription()
      Returns the description text for the KRMS proposition
      Returns:
      description for KRMS type.

    • getTypeId

      String getTypeId()
      Returns the id of Proposition KrmsType of the proposition. It provides some context to what type of object of the KRMS type.
      Returns:
      the id of the KRMS type.

    • getRuleId

      String getRuleId()
      TReturns the ID of the rule this proposition belongs to. May be null if this proposition has not yet been persisted.
      Returns:
      the ID of the Rule this proposition belongs to.

    • getPropositionTypeCode

      String getPropositionTypeCode()

      There are three main types of Propositions: Compound Propositions - a proposition consisting of other propositions and a boolean algebra operator (AND, OR) defining how to evaluate those propositions. Parameterized Propositions - a proposition which is parameterized by some set of values, evaluation logic is implemented by hand and returns true or false Simple Propositions - a proposition of the form lhs op rhs where lhs=left-hand side, rhs=right-hand side, and op=operator

      Returns:
      the proposition type code of the proposition

      Valid values are C = compound, P = parameterized, S = simple

    • getParameters

      List<? extends PropositionParameterContract> getParameters()
      Returns the parameter list of the proposition. Parameters are listed in Reverse Polish Notation. Parameters may be constants, terms, or functions.

      Compound Propositions will have an empty parameter list.

      Returns:
      the Parameters related to the proposition
      See Also:

    • getCompoundOpCode

      String getCompoundOpCode()
      Returns the op code to be used when evaluating compound propositions.
      Returns:
      the compound op code. valid values are A = and, O = or

    • getCompoundSequenceNumber

      Integer getCompoundSequenceNumber()
      Returns the sequence number used to order the compound propositions Note: this value is set by the service
      Returns:
      the compound sequence number

    • getCompoundComponents

      List<? extends PropositionDefinitionContract> getCompoundComponents()
      Returns the propositions which are contained in a compound proposition.
      Returns:
      an ordered list of the Propositions which make up the compound proposition.