Package org.kuali.rice.kew.api.rule

Interface RuleContract

All Superinterfaces:
Identifiable
All Known Implementing Classes:
Rule, Rule.Builder
public interface RuleContract extends Identifiable

  • Method Details

    • getName

      String getName()
      Unique Name for the Rule.

      This is the unique name of the Rule

      Returns:
      name

    • getPreviousRuleId

      String getPreviousRuleId()
      Unique id for the previous version of this Rule.

      This is the unique id value of the previous version of this Rule.

      Returns:
      previousVersionId

    • getRuleTemplate

      RuleTemplateContract getRuleTemplate()
      Unique Id for Template of Rule.

      This is the unique Id of the rule template of the rule

      Returns:
      ruleTemplateId

    • isActive

      boolean isActive()
      The active indicator for the rule.
      Returns:
      true if active false if not.

    • getDescription

      String getDescription()
      The description of the rule.
      Returns:
      description

    • getDocTypeName

      String getDocTypeName()
      The documentTypeName of the rule.
      Returns:
      documentTypeName

    • getFromDate

      org.joda.time.DateTime getFromDate()
      The ending date of the rule.

      This is the date from which the rule stops being be used

      Returns:
      fromDate

    • getToDate

      org.joda.time.DateTime getToDate()
      The ending date of the rule.

      This is the date from which the rule starts to be used

      Returns:
      toDate

    • isForceAction

      boolean isForceAction()
      Shows if rule will force its action.
      Returns:
      boolean value representing if action is forced

    • getRuleResponsibilities

      List<? extends RuleResponsibilityContract> getRuleResponsibilities()
      List of rule responsibilities associated with the Rule
      Returns:
      ruleResponsibilities

    • getRuleExtensions

      List<? extends RuleExtensionContract> getRuleExtensions()
      List of rule extensions associated with the Rule
      Returns:
      ruleExtensions

    • getRuleTemplateName

      String getRuleTemplateName()
      Template Name of the Rule.

      This is the name of the rule template for the rule

      Returns:
      ruleTemplateName

    • getRuleExpressionDef

      RuleExpressionContract getRuleExpressionDef()
      Expression for rule to evaluate.

      This is expression definition of the rule

      Returns:
      ruleExpressionDef