Package oracle.rules.sdk2.decisionpoint

Class DecisionPointInstance

java.lang.Object
oracle.rules.sdk2.decisionpoint.DecisionPointInstance
public class DecisionPointInstance extends Object
DecisionPoint is a helper class which manages the server-side portions of implementing Decision Points (calling OBR Decision Functions) from developers' Java code.

  • Method Details

    • addInput

      public DecisionPointInstance addInput(Object input)
      Adds a fact object to be asserted as the Decision Point is run. The fact objects added MUST be added in the same order as declared in the decision function input table. If a ViewObject is added to the list, ALL database rows represented by the ViewObject will be loaded and asserted to the rule session simultaneously.
      Parameters:
      input -
      Returns:
      self

    • getInputs

      public List<Object> getInputs()
      Get the list of facts to be input to the decision function.
      Returns:
      the list of facts

    • setInputs

      public DecisionPointInstance setInputs(List<Object> input)

    • clearInputs

      public void clearInputs()
      Clear the fact objects input list

    • setViewObject

      public DecisionPointInstance setViewObject(oracle.jbo.ViewObject viewObject)
      Adds a view object to be asserted as the Decision Point is run. This will call the decision function once for each row returned by the decision function, one only one row asserted at a given time.
      Parameters:
      viewObject - the ViewObject to use to load rows
      Returns:
      self

    • getViewObject

      public oracle.jbo.ViewObject getViewObject()
      Return the view object to use for this DecisionPointInstance
      Returns:
      the view object

    • setViewObjectReference

      public DecisionPointInstance setViewObjectReference(ViewObjectReference viewObjectRef)
      Sets a view object reference to be used to load a view object, which can then load datbase rows. Setting this has the same semantics as setViewObject.
      Parameters:
      viewObjectRef - the ViewObjectReference to use to load a ViewObject
      Returns:
      self

    • getViewObjectReference

      public ViewObjectReference getViewObjectReference()
      Return the view object reference to use for this DecisionPointInstance
      Returns:
      the view object reference

    • getTransaction

      public oracle.jbo.server.DBTransactionImpl2 getTransaction()
      Returns the transaction object to be used by this decision point instance. If not previously set, attempts to create a transaction and sets autoCommit to true.
      Returns:
      the transaction

    • setTransaction

      public DecisionPointInstance setTransaction(oracle.jbo.server.DBTransactionImpl2 newtransaction)
      Sets the transaction object to be used by this decision point instance.
      Parameters:
      newtransaction - the transaction to use
      Returns:
      self

    • setTransaction

      public DecisionPointInstance setTransaction(Connection connection) throws SDKException
      Bootstraps and sets a transaction object from given a database Connection. This option is less efficient than setting the transaction via an ApplicationModule's in-built transaction object.
      Parameters:
      connection - the Connection instance to use
      Returns:
      self
      Throws:
      SDKException - if a NamingException occurs when trying to create a Transaction object from this Connection

    • setTransaction

      public DecisionPointInstance setTransaction(String dataSrcName) throws SDKException
      Bootstraps and sets a transaction object given a J2EE data source name. The data source name must be registered to the J2EE container or else an exception will occur.
      Parameters:
      dataSrcName - name of the data source
      Returns:
      self
      Throws:
      SDKException - if the data srouce cannot be found or an exception coccurs when trying to create new transaction from the decision point

    • getDecisionPoint

      public DecisionPoint getDecisionPoint()
      Return the template DecisionPoint which created this DecisionPointInstance
      Returns:
      the decision point

    • getProperties

      public Map<String,Object> getProperties()
      Return the map of properties local to this DecisionPointInstance. This will not include the properties which are set in the parent DecisionPoint
      Returns:
      the map of properties

    • getProperty

      public Object getProperty(String name)
      Return a property value of the given name. If a property of the given name exists in this DecisionPointInstance, the value is returned. Otherwise, the value set for the property in the parent DecisionPoint is returned. If the property is not set in either, null is returned.
      Parameters:
      name - the name of the property to retrive
      Returns:
      the property value

    • setProperty

      public DecisionPointInstance setProperty(String name, Object value)
      Set a property value only in this DecisionPointInstance.
      Parameters:
      name - the name of a property to set
      value - the value of the property to set
      Returns:
      self

    • setRuleSession

      public DecisionPointInstance setRuleSession(RuleSession session) throws SDKException, RLException
      Set the RuleSession to use explicitly. This is most commonly used only when calling the DecisionPoint from a web service that manages its own pool of RuleSessions.
      Parameters:
      session - the rule session to use
      Throws:
      SDKException - if there is an error generating the RL for the rule session
      RLException - if the rulesession throws an RLException

    • ruleSession

      public RuleSession ruleSession() throws SDKException
      Returns the RuleSession instance that was or will be used by this DecisionPointInstance. If the RuleSession was not explicitly set or if one can not be obtained from the pool, null is returned.
      Returns:
      the rule session in use for this instance
      Throws:
      SDKException

    • setDictionary

      public void setDictionary(RuleDictionary dict)
      set dictionary to use for trace analysis

    • getDictionary

      public RuleDictionary getDictionary()
      get dictionary to use for trace analysis

    • cleanup

      public void cleanup() throws SDKException
      If invoke is called with the parameter false, then this method must be called before the decision point instance reference goes out of scope, otherwise a memory leak will occur. Preferrably, the call to this should be placed in a finally block.
      Throws:
      SDKException

    • getActivationID

      public int getActivationID()
      Get the activation id for the ADF-BC objects used in this decision point instance.
      Returns:
      the id

    • setActivationID

      public DecisionPointInstance setActivationID(Integer id)
      Set the activation id for the ADF-BC objects used in this decision point instance.
      Parameters:
      id - the activation id
      Returns:
      self

    • decisionTrace

      public DecisionTrace decisionTrace() throws SDKException
      Throws:
      SDKException

    • invoke

      public List<Object> invoke() throws RLException, SDKException
      Executes the decision function, marshalling its parameters to the rules engine and returning any values spooled back by the ActionType instances. This is the perferred invoke method. This method has the same effect of calling invoke(true), meaning that it returns the RuleSession to the pool after finishing with it.
      Returns:
      a list of NamedValue objects, which may be empty but will never be null
      Throws:
      RLException - if the rule session throws an RLException
      SDKException - if there is an error accessing the dictionary or with specified parameters

    • invoke

      public List<Object> invoke(boolean ret) throws RLException, SDKException
      Executes the desired Decision Function, marshalling its parameters to the OBR rules engine and returning any values spooled back by the ActionType instances. This method should only be used in advanced usage cases. The majority of uses should use the no-arg method of the same name.
      Parameters:
      ret - if true, the rule session is returned to the pool after execution. If false, the rule session used by execution is not returned to the rule session pool. If method cleanup() is not subsequently called, this can lead to a memory leak.
      Returns:
      a list of NamedValue objects, which may be empty but will never be null
      Throws:
      RLException - if the rule session throws an RLException
      SDKException - if there is an error accessing the dictionary or with specified parameters

    • addResult

      public DecisionPointInstance addResult(String name, Object value)
      addResult spools a named output value for return to the caller of the Decision Function. Output is not a map, so the name need not be distinct.
      Parameters:
      name - The name of the output
      value - The value of the output
      Returns:
      self

    • addResults

      public DecisionPointInstance addResults(List<DecisionPoint.NamedValue> toadd)
      addResults is used to spool a list of output values, guaranteeing that the resultant values will be spooled together regardless of what other Action Type instances may also be spooling values.
      Parameters:
      toadd - A list of NamedValue objects to add to this instance
      Returns:
      self

    • getResults

      public List<DecisionPoint.NamedValue> getResults()
      Get the NamedValue results of executing this decision point
      Returns:
      a list with NamedValue objects

    • assertViewObjectsForWS

      public void assertViewObjectsForWS(List<ViewObjectRef> lvor) throws RLException, SDKException
      Assert a set of ViewObjects from a list of ViewObjectRef
      Parameters:
      lvor - list containing the view object refs
      Throws:
      RLException - if the rule session throws an RLException
      SDKException - if there is an error accessing the dictionary or with specified parameters

    • assertViewObjectsForWS

      public void assertViewObjectsForWS() throws RLException, SDKException
      Assert a set of ViewObjects from a SimpleDecisionPointInput
      Throws:
      RLException - if the rule session throws an RLException
      SDKException - if there is an error accessing the dictionary or with specified parameters

    • processWebOutputs

      public void processWebOutputs() throws RLException, SDKException
      Internal Use Only.
      Throws:
      RLException
      SDKException

    • setEffectiveDate

      public static void setEffectiveDate(RuleSession rs, Calendar cal) throws RLException
      Set the rule set effective date to be used by this decision point
      Parameters:
      rs - the rulesession in which to set the effective date
      cal - the date representation to set
      Throws:
      RLException

    • setCurrentDate

      public static void setCurrentDate(RuleSession rs, Calendar cal) throws RLException
      Set the rule set current date to be used by this decision point
      Parameters:
      rs - the rulesession in which to set the current date
      cal - the date representation to set
      Throws:
      RLException

    • setAutoCommit

      public void setAutoCommit(boolean m_autoCommit)

    • isAutoCommit

      public boolean isAutoCommit()

    • spool

      @Deprecated public DecisionPointInstance spool(ActionType action)
      Deprecated.
      Internal Use Only. Spool an action instance for in-order execution

    • loadEntireAdfBcViewObject

      @Deprecated public List<RLObject> loadEntireAdfBcViewObject(RuleSession ruleSession, oracle.jbo.ViewObject viewObject) throws SDKException, RLException
      Deprecated.
      Throws:
      SDKException
      RLException

    • loadEntireAdfBcViewObject

      @Deprecated public List<RLObject> loadEntireAdfBcViewObject(String dictionaryName, RuleSession ruleSession, oracle.jbo.ViewObject viewObject) throws SDKException, RLException
      Deprecated.
      Throws:
      SDKException
      RLException

    • loadBatchAdfBcViewObject

      @Deprecated public List<RLObject> loadBatchAdfBcViewObject(RuleSession ruleSession, oracle.jbo.ViewObject viewObject) throws SDKException, RLException
      Deprecated.
      Throws:
      SDKException
      RLException

    • loadBatchAdfBcViewObject

      @Deprecated public List<RLObject> loadBatchAdfBcViewObject(String dictionaryName, RuleSession ruleSession, oracle.jbo.ViewObject viewObject) throws SDKException, RLException
      Deprecated.
      Throws:
      SDKException
      RLException

    • process

      @Deprecated public DecisionPointInstance process()
      Deprecated.
      Internal Use Only. This method is called by the postprocessing ruleset.