Package oracle.rules.sdk2.ruleset

Class RuleBase<T extends RuleBase>

java.lang.Object
oracle.rules.sdk2.dictionary.DictionaryObject
oracle.rules.sdk2.dictionary.DictionaryComponent<T>
oracle.rules.sdk2.ruleset.RuleComponent<T>
oracle.rules.sdk2.ruleset.RuleBase<T>
All Implemented Interfaces:
Serializable, Cloneable, Map<String,Object>, ActionContext, AutoBindingContext, VariableScope
Direct Known Subclasses:
RuleCommon, VerbalRule
public abstract class RuleBase<T extends RuleBase> extends RuleComponent<T> implements ActionContext, AutoBindingContext
Base Class for any form of Rule (Rule, RuleSheet, VerbalRule etc) Contains only properties and behavior shared by all Rule Forms (Header properties and SimpleTests)
Since:
12.1.2
Author:
Ganesh RK
See Also:

  • Method Details

    • getPropertyNames

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

    • getStoredPropertyNames

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

    • 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()

    • getTreeModeProperty

      public SettableProperty<Boolean> getTreeModeProperty()
      Get TreeMode Property.
      Returns:
      boolean SettableProperty

    • isTreeMode

      public boolean isTreeMode()
      is tree mode set?
      Specified by:
      isTreeMode in interface AutoBindingContext
      Returns:
      boolean

    • setTreeMode

      public void setTreeMode(boolean flag)
      Set tree mode. Must call RuleDictionary.update(java.util.List<oracle.rules.sdk2.exception.SDKWarning>) after changing tree mode.
      Parameters:
      flag - boolean flag

    • getPriorityProperty

      public TranslatedProperty getPriorityProperty()
      Get Priority Property.
      Returns:
      String SettableProperty

    • getPriority

      public String getPriority()
      Get a String containing a priority level or a negative or positive integer. Defaults to "medium".

    • setPriority

      public void setPriority(String priority)
      Set a String containing a priority a level, e.g. "high", or a negative or positive integer. Defaults to "medium".

    • getPriorityOptions

      public String[] getPriorityOptions()
      get list of predefined priority levels 
       highest = 3000
 higher  = 2000
 high    = 1000
 medium  = 0
 low     = -1000
 lower   = -2000
 lowest  = -3000
      Returns:
      array of priorities

    • isVisible

      public boolean isVisible()
      Is the Rule visible according the containing RuleSet's visibility filter?
      Returns:
      boolean

    • getSimpleTestTableProperty

      public TableProperty<SimpleTest> getSimpleTestTableProperty()
      Get SimpleTestTable Property.
      Returns:
      SimpleTest TableProperty

    • getSimpleTestTable

      public SimpleTestTable getSimpleTestTable()
      Get the SimpleTestTable for the Rule/VerbalRule or DT The table is empty for advanced mode Rules and DTs.
      Specified by:
      getSimpleTestTable in interface AutoBindingContext
      Returns:
      SimpleTestTable

    • 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<T extends RuleBase>
      Parameters:
      key - a String containing the property name to be fetched.
      Returns:
      the value corresponding to the key: a String, String[], DictionaryComponent, DictionaryComponentTable, etc.

    • getIntPriority

      public int getIntPriority()

    • isValid

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

    • mustNotBeTreeMode

      public boolean mustNotBeTreeMode()

    • validate

      public void validate(List<SDKWarning> warnings, String... exclude)
      Validate and return errors and warnings

    • 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<T extends RuleBase>

    • getReturnExpressionTableSize

      public int getReturnExpressionTableSize()
      Specified by:
      getReturnExpressionTableSize in interface ActionContext

    • genRLBindVars

      public void genRLBindVars()
      generation of RL scoped vars
      Specified by:
      genRLBindVars in interface ActionContext

    • getSimpleTests

      public List<SimpleTest> getSimpleTests()
      Returns:
      Return all simple tests in the Rule/VerbalRule. Empty in case of Advanced Mode Rules.

    • getActions

      public abstract List<Action> getActions()

    • RHSRuleVariables

      public List<ScopedVariable> RHSRuleVariables(boolean includeAggregates)
      Return all rule variables available to the Action of a rule
      Overrides:
      RHSRuleVariables in class RuleComponent<T extends RuleBase>

    • getRoot

      public FactBinding getRoot()
      Return the first test, creating if needed
      Specified by:
      getRoot in interface AutoBindingContext
      Returns:
      FactBinding

    • getRuleType

      public RuleBase.RuleType getRuleType()