Package oracle.rules.sdk2.ruleset

Class RuleSet

java.lang.Object
oracle.rules.sdk2.dictionary.DictionaryObject
oracle.rules.sdk2.dictionary.DictionaryComponent<T>
oracle.rules.sdk2.ruleset.RuleComponent<RuleSet>
oracle.rules.sdk2.ruleset.RuleSet
All Implemented Interfaces:
Serializable, Cloneable, Map<String,Object>, VariableScope
public class RuleSet extends RuleComponent<RuleSet>
A RuleSet has a name, a table of Rules, and a table of RuleSheets.
See Also:

  • Method Details

    • getRule

      public Rule getRule(int index)
      Get the Rule at the given index
      Returns:
      the Rule

    • getRuleByID

      public Rule getRuleByID(DOID id)
      Get the Rule with the given ID
      Returns:
      the Rule

    • getRuleByName

      public Rule getRuleByName(String name)
      Get the Rule with the given name
      Returns:
      the Rule

    • getVerbalRule

      public VerbalRule getVerbalRule(int index)
      Get the Verbal Rule at the given index
      Returns:
      the VerbalRule

    • getVerbalRuleByID

      public VerbalRule getVerbalRuleByID(DOID id)
      Get the Verbal Rule with the given ID
      Returns:
      the VerbalRule

    • getVerbalRuleByName

      public VerbalRule getVerbalRuleByName(String name)
      Get the Verbal Rule with the given name
      Returns:
      the VerbalRule

    • validate

      public void validate(List<SDKException> errors, List<SDKWarning> warnings, int modelChangeLowerBound, int ruleChangeLowerBound)
      Description copied from class: DictionaryObject
      Validate the RuleDictionary object. Append error and warning exceptions. Errors will cause RuleDictionary.update(java.util.List<oracle.rules.sdk2.exception.SDKWarning>) to throw an exception. A dictionary with warnings but no errors can be persisted.
      Overrides:
      validate in class DictionaryObject
      Parameters:
      errors - a List of error exceptions to append to.
      warnings - a List of warning exceptions to append to.
      modelChangeLowerBound - smallest ModelComponent.CreationUpdateNumber modified in thix tx.
      ruleChangeLowerBound - smallest RuleComponent.CreationUpdateNumber modified in thix tx. Rulesets and rules with UpdateNumber >= modelChangeLowerBound will be revalidated. a value of 0 will force revalidation of all rulesets. A value of Integer.MAX_VALUE will skip validation of all rulesets.

    • validate

      public void validate(List<SDKException> errors, List<SDKWarning> warnings)
      Description copied from class: DictionaryComponent
      Validate and append errors and warnings.
      Overrides:
      validate in class DictionaryComponent<RuleSet>
      Parameters:
      errors - a List of error exceptions to append to.
      warnings - a List of warning exceptions to append to.
      See Also:

    • generateRL

      public String generateRL() throws SDKException
      Validates then generates RL code for the rule set. Used in conjunction with the code produced by (@LINK generateModelRL()).
      Returns:
      A String containing the executable RL rule set
      Throws:
      SDKException

    • getRuleTableProperty

      public TableProperty<Rule> getRuleTableProperty()
      Get RuleTable Property.
      Returns:
      Rule TableProperty

    • getRuleTable

      public RuleTable getRuleTable()
      Get the table of Rules used to access and rearrange Rules in the RuleSet.

    • getRuleSheetTableProperty

      public TableProperty<RuleSheet> getRuleSheetTableProperty()
      Get RuleSheetTable Property.
      Returns:
      RuleSheet TableProperty

    • getRuleSheetTable

      public RuleSheetTable getRuleSheetTable()
      Get the table of rule sheets (decision tables) used to access and rearrange rule sheets in the RuleSet.

    • getVerbalRuleTableProperty

      public TableProperty<VerbalRule> getVerbalRuleTableProperty()
      Get VerbalRuleTable Property.
      Returns:
      VerbalRule TableProperty

    • getVerbalRuleTable

      public VerbalRuleTable getVerbalRuleTable()
      Get the table of Verbal Rules used to access and rearrange Verbal Rules in the RuleSet.

    • isCustomizable

      @Deprecated public boolean isCustomizable()
      Deprecated.
      no replacement

    • setCustomizable

      @Deprecated public void setCustomizable(boolean flag)
      Deprecated.
      no replacement

    • getActiveProperty

      public SettableProperty<Boolean> getActiveProperty()
      Get Active Property.
      Returns:
      boolean SettableProperty

    • isActive

      public boolean isActive()
      Returns value of the active property.
      Returns:
      boolean

    • setActive

      public void setActive(boolean active)
      sets the active property
      Parameters:
      active - boolean value

    • getEffectiveStartDateProperty

      public SettableProperty<String> getEffectiveStartDateProperty()
      Get EffectiveStartDate Property.
      Returns:
      String SettableProperty

    • getEffectiveStartDate

      public String getEffectiveStartDate()
      Get Effective Start Date.
      Returns:
      String

    • setEffectiveStartDate

      public void setEffectiveStartDate(String date)

    • getEffectiveEndDateProperty

      public SettableProperty<String> getEffectiveEndDateProperty()
      Get EffectiveEndDate Property.
      Returns:
      String SettableProperty

    • getEffectiveEndDate

      public String getEffectiveEndDate()
      Get Effective End Date.
      Returns:
      String

    • setEffectiveEndDate

      public void setEffectiveEndDate(String date)

    • getCalendarFormProperty

      public TranslatedProperty getCalendarFormProperty()
      Get CalendarForm Property.
      Returns:
      TranslatedProperty

    • getCalendarForm

      public String getCalendarForm()
      Get Calendar Form (Date, Time, or DateTime). Default is DateTime. This applies to both the effective start date property and the the effective end date property.
      Returns:
      String

    • setCalendarForm

      public void setCalendarForm(String form)

    • getCalendarFormOptions

      public String[] getCalendarFormOptions()

    • getCalendarFormSelected

      public int getCalendarFormSelected()

    • get

      public Object get(Object key)
      Description copied from class: DictionaryComponent
      Generic property getter.

      Please see the specific bean class for a list of properties.

      Specified by:
      get in interface Map<String,Object>
      Overrides:
      get in class DictionaryComponent<RuleSet>
      Parameters:
      key - a String containing the property name to be fetched.
      Returns:
      the value corresponding to the key: a String, String[], DictionaryComponent, DictionaryComponentTable, etc.

    • isValid

      public boolean isValid()
      is the rule set valid?
      Returns:
      boolean result

    • getPropertyNames

      public String[] getPropertyNames()
      Overrides:
      getPropertyNames in class DictionaryComponent<RuleSet>
      Returns:
      Array of property names available.

    • getStoredPropertyNames

      public String[] getStoredPropertyNames()
      Overrides:
      getStoredPropertyNames in class DictionaryComponent<RuleSet>
      Returns:
      Array of property names which are persisted in the order in which they appear in the schema.

    • inScopeVariables

      public List<ScopedVariable> inScopeVariables(boolean includeAggregates, VariableScope.ExprLocation loc)
      Description copied from class: RuleComponent
      By default, pass the request to the container
      Specified by:
      inScopeVariables in interface VariableScope
      Overrides:
      inScopeVariables in class RuleComponent<RuleSet>

    • getVisibilityFilter

      public SimpleTestTable getVisibilityFilter()

    • isVisibilityFilterEnabled

      public boolean isVisibilityFilterEnabled()

    • setVisibilityFilterEnabled

      public void setVisibilityFilterEnabled(boolean flag)

    • put

      public Object put(String key, Object value)
      Description copied from class: DictionaryComponent
      Generic property setter. Throws runtime exceptions for incorrect arguments. Please see the specific bean class for a list of properties, their types, and permissible values.

      A put() with either null key or null value throws a NullPointerException.

      A put() with a key that is not a String throws a ClassCastException

      A put() of a value that is not of the correct type for the key throws a ClassCastException.

      Bean properties which have no set() method are read only, and cannot be modified using the put(). Attempting to do so throws a runtime IllegalArgumentException. PROP_ID, and PROP_*_SELECTED are always read only.

      Specified by:
      put in interface Map<String,Object>
      Overrides:
      put in class DictionaryComponent<RuleSet>
      Parameters:
      key - the key of the property to set
      value - the value of the named property to set
      Returns:
      the previous value of the property

    • getCreationUpdateNumber

      public int getCreationUpdateNumber()
      RuleSets have an immutable creation update number. Decision functions with a lower validation update number cannot depend this ruleset.
      Returns:
      the dictionary update number when this component was created

    • getRelevanceAndAssociationContext

      public RelevanceAndAssociationContext getRelevanceAndAssociationContext()

    • getAllRules

      public List<? extends RuleBase> getAllRules()
      Get All the rules in this RuleSet regardless of its type - Rule, VerbalRule or RuleSheet
      Returns:
      consolidated list of all Rules in this RuleSet

    • getAllRules

      public List<? extends RuleBase> getAllRules(String filterPattern, boolean translate)
      Get All the rules in this RuleSet filtered by the given pattern
      Parameters:
      filterPattern - pattern for filtering
      translate - boolean value to indicate if the translated value should be used for filtering
      Returns:
      consolidated list of all Rules in the RuleSet filtered by the given pattern