Package org.camunda.bpm.dmn.engine

Interface DmnDecisionResult

All Superinterfaces:
Collection<DmnDecisionResultEntries>, Iterable<DmnDecisionResultEntries>, List<DmnDecisionResultEntries>, Serializable
All Known Implementing Classes:
DmnDecisionResultImpl
public interface DmnDecisionResult extends List<DmnDecisionResultEntries>, Serializable

The result of one decision evaluation. It can be composed of multiple DmnDecisionResultEntriess which represents the output entries (i.e., pairs of output name and value).

In case of a decision with a decision table, the result has one DmnDecisionResultEntries for each matched rule that contains the output entries of this rule.

  • Method Details

    • getFirstResult

      DmnDecisionResultEntries getFirstResult()
      Returns the first DmnDecisionResultEntries.
      Returns:
      the first decision result or null if none exits

    • getSingleResult

      DmnDecisionResultEntries getSingleResult()
      Returns the single DmnDecisionResultEntries of the result. Asserts that only one decision result exist.
      Returns:
      the single decision result or null if none exists
      Throws:
      DmnEngineException - if more than one decision result exists

    • collectEntries

      <T> List<T> collectEntries(String outputName)
      Collects the entries for a output name. The list will contain entries for the output name of every DmnDecisionResultEntries. Note that the list may contains less entries than decision results if an output does not contain a value for the output name.
      Type Parameters:
      T - the type of the result entry
      Parameters:
      outputName - the name of the output to collect
      Returns:
      the list of collected output values

    • getResultList

      List<Map<String,Object>> getResultList()
      Returns the entries of all decision results. For every decision result a map of the output names and corresponding entries is returned.
      Returns:
      the list of all entry maps
      See Also:

    • getSingleEntry

      <T> T getSingleEntry()
      Returns the value of the single entry of the decision result. Asserts that only one decision result with a single entry exist.
      Type Parameters:
      T - the type of the result entry
      Returns:
      the value of the single result entry or null if none exists
      Throws:
      DmnEngineException - if more than one decision result or more than one result entry exists
      See Also:

    • getSingleEntryTyped

      <T extends TypedValue> T getSingleEntryTyped()
      Returns the typed value of the single entry of the decision result. Asserts that only one decision result with a single entry exist.
      Type Parameters:
      T - the type of the result entry
      Returns:
      the typed value of the single result entry or null if none exists
      Throws:
      DmnEngineException - if more than one decision result or more than one result entry exists
      See Also: