Package oracle.rules.sdk2.datamodel

Class DecisionFunction

java.lang.Object
oracle.rules.sdk2.dictionary.DictionaryObject
oracle.rules.sdk2.dictionary.DictionaryComponent<T>
oracle.rules.sdk2.datamodel.ModelComponent<DecisionFunction>
oracle.rules.sdk2.datamodel.DecisionFunction
All Implemented Interfaces:
Serializable, Cloneable, Map<String,Object>, Callable, ActionContext
public class DecisionFunction extends ModelComponent<DecisionFunction> implements Callable, ActionContext
See Also:

  • Field Details

  • Constructor Details

  • Method Details

    • getUniqueRulesetsProperty

      public SettableProperty<Boolean> getUniqueRulesetsProperty()
      get UniqueRulesets Property.
      Returns:
      SettableProperty

    • isUniqueRulesets

      public boolean isUniqueRulesets()
      True if unique rulesets will appear on the ruleset stack during rule execution, false otherwise.
      Returns:
      boolean

    • setUniqueRulesets

      public void setUniqueRulesets(boolean isUniqueRulesets)
      Set whether or not unique rulesets will appear on the ruleset stack during rule execution
      Parameters:
      isUniqueRulesets -

    • getRuleFiringLimitErrorProperty

      public SettableProperty<Boolean> getRuleFiringLimitErrorProperty()
      get RuleFiringLimitError Property.
      Returns:
      SettableProperty

    • isRuleFiringLimitError

      public boolean isRuleFiringLimitError()
      true if reaching the rule firing limit is an error, false otherwise.
      Returns:
      boolean

    • setRuleFiringLimitError

      public void setRuleFiringLimitError(boolean isLimitError)
      set if reaching the rule firing limit is an error or not
      Parameters:
      isLimitError - is reaching the rule firing limit an Error

    • getRuleFiringLimitProperty

      public TranslatedProperty getRuleFiringLimitProperty()
      get RuleFiringLimit Property.
      Returns:
      TranslatedProperty

    • getRuleFiringLimit

      public String getRuleFiringLimit()
      Get limit on how many rules can fire. A positive integer or "unlimited".
      Returns:
      string representing the limit

    • getRuleFiringLimitOptions

      public String[] getRuleFiringLimitOptions()
      get Rule firing limit options ("unlimited") User can also enter a positive integer.
      Returns:
      a string list of firing limit options

    • setRuleFiringLimit

      public void setRuleFiringLimit(String limit)
      set limit on how many rules to fire.
      Parameters:
      limit - a positive integer or "unlimited".

    • getWebServiceProperty

      public SettableProperty<Boolean> getWebServiceProperty()
      Get WebService Property.
      Returns:
      Boolean SettableProperty

    • isWebService

      public boolean isWebService()
      is this decision function to be exposed as a web service?
      Returns:
      boolean

    • setWebService

      public void setWebService(boolean flag)
      Set whether this decision function to be exposed as a web service
      Parameters:
      flag - boolean flag

    • getCheckRuleFlowProperty

      public SettableProperty<Boolean> getCheckRuleFlowProperty()
      Get CheckRuleFlow Property.
      Returns:
      Boolean SettableProperty

    • isCheckRuleFlow

      public boolean isCheckRuleFlow()
      is this decision function type-checked for rule flow?
      Returns:
      boolean

    • setCheckRuleFlow

      public void setCheckRuleFlow(boolean flag)
      Set whether this decision function should be checked for rule flow
      Parameters:
      flag - boolean flag

    • getStatelessProperty

      public SettableProperty<Boolean> getStatelessProperty()
      Get Stateless Property.
      Returns:
      Boolean SettableProperty

    • isStateless

      public boolean isStateless()
      is this decision function stateless (RuleSession can be returned to pool)?
      Returns:
      boolean

    • setStateless

      public void setStateless(boolean flag)
      Set whether this decision function is stateless (RuleSession can be returned to pool)
      Parameters:
      flag - boolean flag

    • getDecisionFunctionInputTableProperty

      public TableProperty<DecisionFunctionFact> getDecisionFunctionInputTableProperty()
      Get DecisionFunctionInputTable Property.
      Returns:
      DecisionFunctionFact TableProperty

    • getDecisionFunctionInputTable

      public DecisionFunctionFactTable getDecisionFunctionInputTable()
      Get Decision Function Input Table
      Returns:
      DecisionFunctionInputTable

    • getDecisionFunctionRuleSetTableProperty

      public TableProperty<DecisionFunctionRuleSet> getDecisionFunctionRuleSetTableProperty()
      Get DecisionFunctionRuleSetTable Property.
      Returns:
      DecisionFunctionRuleSet TableProperty

    • getDecisionFunctionRuleSetTable

      public DecisionFunctionRuleSetTable getDecisionFunctionRuleSetTable()
      get DecisionFunctionRuleSetTable
      Returns:
      DecisionFunctionRuleSetTable

    • getActionTableProperty

      public TableProperty<Action> getActionTableProperty()
      Get ActionTable Property.
      Returns:
      Action TableProperty

    • getActionTable

      public ActionTable getActionTable()
      get ActionTable. Actions are executed after rulesets are pushed on the stack but before asserting input facts. Actions may reference decision function inputs but not outputs. Actions may assert new outputs, however.
      Returns:
      ActionTable

    • getRuleSetOptions

      @Deprecated public String[] getRuleSetOptions()
      Deprecated.
      use {@link #getDecisionFunctionRuleSetTable().getPrototype().getRuleSetOptions()}
      get options for RuleSet aliases, used in ading a new DecisionFunctionRuleSet The options do not include already selected rulesets. Nor do the options include "". This method is intended for use in a shuttle UI.
      Returns:
      array of ruleset aliases

    • getDecisionFunctionOptions

      @Deprecated public String[] getDecisionFunctionOptions()
      Deprecated.
      use {@link #getDecisionFunctionRuleSetTable().getPrototype().getDecisionFunctionProperty().getOptions()}
      get options for decision function aliases, used in ading a new DecisionFunctionRuleSet The options do not include already selected decision functions. Nor do the options include "". This method is intended for use in a shuttle UI.
      Returns:
      array of decision function aliases

    • getDecisionFunctionOutputTableProperty

      public TableProperty<DecisionFunctionFact> getDecisionFunctionOutputTableProperty()
      Get DecisionFunctionOutputTable Property.
      Returns:
      DecisionFunctionFact TableProperty

    • getDecisionFunctionOutputTable

      public DecisionFunctionFactTable getDecisionFunctionOutputTable()
      Get Decision Function Output Table
      Returns:
      DecisionFunctionOutputTable

    • getRuleSets

      public Collection<String> getRuleSets()
      get all the rulesets referenced directly or indirectly by this decision function (including referenced decision functions) Duplicates are eliminated.
      Returns:
      Collection of ruleset names

    • getFunctionSignature

      public String getFunctionSignature()
      Get the decision function signature -- an alias-substituted RL function signature
      Returns:
      String

    • getWrapperSignature

      @Deprecated public String getWrapperSignature()
      Deprecated.
      No replacement.
      Get the decision function wrapper signature -- an RL function that accepts and returns DOM Nodes
      Returns:
      String

    • 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<DecisionFunction>
      Parameters:
      errors - a List of error exceptions to append to.
      warnings - a List of warning exceptions to append to.
      See Also:

    • 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.

    • get

      public Object get(Object key)
      Override hashtable get method.
      Specified by:
      get in interface Map<String,Object>
      Overrides:
      get in class DictionaryComponent<DecisionFunction>
      Parameters:
      key - a String containing the property name to be fetched.
      Returns:
      the value corresponding to the key

    • getPropertyNames

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

    • getStoredPropertyNames

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

    • getParameters

      public List<? extends Parameter> getParameters()
      Description copied from interface: Callable
      Get all the parameters of the callable interface (Function/Method/Constructor) Function returns FormalParameterTable and Method/Constructor return OverloadedParameterTable
      Specified by:
      getParameters in interface Callable
      Returns:
      all the formal parameters of the callable interface

    • getTypeID

      public DOID getTypeID()
      Description copied from interface: Callable
      Get alias of the return type
      Specified by:
      getTypeID in interface Callable
      Returns:
      alias of the return type

    • _getTypeID

      public DOID _getTypeID()
      Description copied from interface: Callable
      Get ID of the return type without sync'ing with type alias
      Specified by:
      _getTypeID in interface Callable
      Returns:
      alias of the return type

    • getType

      public String getType()
      Description copied from interface: Callable
      Get alias of the return type
      Specified by:
      getType in interface Callable
      Returns:
      alias of the return type

    • getParameterList

      public String getParameterList()
      Get parameter list as a String
      Specified by:
      getParameterList in interface Callable
      Returns:
      return the method's parameter list in the format paramType, paramType ...

    • getParameterList

      public String getParameterList(boolean translate)
      Get optionally translated parameter list as a String
      Specified by:
      getParameterList in interface Callable
      Returns:
      return the method's parameter list in the format paramType, paramType ...

    • 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

    • getActions

      public List<Action> getActions()

    • getModifiers

      public Modifiers getModifiers()
      Specified by:
      getModifiers in interface Callable

    • getExceptionIDs

      public DOID[] getExceptionIDs()
      Specified by:
      getExceptionIDs in interface Callable