Package org.camunda.bpm.dmn.engine

Interface DmnDecisionRuleResult

  • All Superinterfaces:
    java.util.Map<java.lang.String,​java.lang.Object>, java.io.Serializable
    All Known Implementing Classes:
    DmnDecisionRuleResultImpl
    public interface DmnDecisionRuleResult
extends java.util.Map<java.lang.String,​java.lang.Object>, java.io.Serializable
    The result of one decision rule. This represents the output entry values of a matching decision rule. It is a mapping from the output name attribute to the output value. If no name was given the key is null.

    • Nested Class Summary

      • Nested classes/interfaces inherited from interface java.util.Map

        java.util.Map.Entry<K extends java.lang.Object,​V extends java.lang.Object>

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      <T> T getEntry​(java.lang.String name)
      Returns the value of the rule result entry for a given output name.
      java.util.Map<java.lang.String,​java.lang.Object> getEntryMap()
      Returns a map of the rule result entry values by output name.
      java.util.Map<java.lang.String,​TypedValue> getEntryMapTyped()
      Returns a map of the typed rule result entry values by output name.
      <T extends TypedValue>
      T      		 getEntryTyped​(java.lang.String name)
      Returns the typed value of the rule result entry for a given output name.
      <T> T getFirstEntry()
      Returns the value of the first rule result entry.
      <T extends TypedValue>
      T      		 getFirstEntryTyped()
      Returns the typed value of the first rule result entry.
      <T> T getSingleEntry()
      Returns the value of the single entry of the decision rule result.
      <T extends TypedValue>
      T      		 getSingleEntryTyped()
      Returns the typed value of the single entry of the decision rule result.

      • Methods inherited from interface java.util.Map

        clear, compute, computeIfAbsent, computeIfPresent, containsKey, containsValue, entrySet, equals, forEach, get, getOrDefault, hashCode, isEmpty, keySet, merge, put, putAll, putIfAbsent, remove, remove, replace, replace, replaceAll, size, values

    • Method Detail

      • getFirstEntry

        <T> T getFirstEntry()
        Returns the value of the first rule result entry.
        Type Parameters:
        T - the type of the rule result entry
        Returns:
        the value of the first rule result entry or null if none exists
        See Also:
        getFirstEntryTyped()

      • getFirstEntryTyped

        <T extends TypedValue> T getFirstEntryTyped()
        Returns the typed value of the first rule result entry.
        Type Parameters:
        T - the type of the rule result entry
        Returns:
        the typed value of the first rule result entry or null if none exists
        See Also:
        getFirstEntry()

      • getSingleEntry

        <T> T getSingleEntry()
        Returns the value of the single entry of the decision rule result. Which asserts that the decision rule result only has one entry.
        Type Parameters:
        T - the type of the rule result entry
        Returns:
        the value of the single rule result entry or null if none exists
        Throws:
        DmnEngineException - if more than one rule result entry exists
        See Also:
        getSingleEntryTyped()

      • getSingleEntryTyped

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

      • getEntry

        <T> T getEntry​(java.lang.String name)
        Returns the value of the rule result entry for a given output name.
        Type Parameters:
        T - the type of the rule result entry
        Parameters:
        name - the name of the output
        Returns:
        the value for the given name or null if no value exists for this name
        See Also:
        getEntryTyped(String)

      • getEntryTyped

        <T extends TypedValue> T getEntryTyped​(java.lang.String name)
        Returns the typed value of the rule result entry for a given output name.
        Type Parameters:
        T - the type of the rule result entry
        Parameters:
        name - the name of the output
        Returns:
        the typed value for the given name or null if no value exists for this name
        See Also:
        getEntry(String)

      • getEntryMap

        java.util.Map<java.lang.String,​java.lang.Object> getEntryMap()
        Returns a map of the rule result entry values by output name.
        Returns:
        the values of the decision rule result entries
        See Also:
        getEntryMapTyped()

      • getEntryMapTyped

        java.util.Map<java.lang.String,​TypedValue> getEntryMapTyped()
        Returns a map of the typed rule result entry values by output name.
        Returns:
        the typed values of the decision rule result entries
        See Also:
        getEntryMap()