org.camunda.bpm.dmn.engine
Interface DmnDecisionTableResult

All Superinterfaces:

Collection<DmnDecisionRuleResult>, Iterable<DmnDecisionRuleResult>, List<DmnDecisionRuleResult>, Serializable

All Known Implementing Classes:

DmnDecisionTableResultImpl

public interface DmnDecisionTableResult
extends List<DmnDecisionRuleResult>, Serializable

The result of one decision table. Which is the list of its decision rule results (see DmnDecisionRuleResult). This represents the output entries of all matching decision rules.

Method Summary

<T> List<T>	collectEntries(String outputName) Collects the entries for a output name.
DmnDecisionRuleResult	getFirstResult() Returns the first DmnDecisionRuleResult.
List<Map<String,Object>>	getResultList() Returns the entries of all decision rule results.
<T> T	getSingleEntry() Returns the value of the single entry of the decision rule result.
<T extends org.camunda.bpm.engine.variable.value.TypedValue> T	getSingleEntryTyped() Returns the typed value of the single entry of the decision rule result.
DmnDecisionRuleResult	getSingleResult() Returns the single DmnDecisionRuleResult of the result.

Methods inherited from interface java.util.List

add, add, addAll, addAll, clear, contains, containsAll, equals, get, hashCode, indexOf, isEmpty, iterator, lastIndexOf, listIterator, listIterator, remove, remove, removeAll, retainAll, set, size, subList, toArray, toArray

Method Detail

getFirstResult

DmnDecisionRuleResult getFirstResult()

Returns the first DmnDecisionRuleResult.

Returns:

the first decision rule result or null if none exits

getSingleResult

DmnDecisionRuleResult getSingleResult()

Returns the single DmnDecisionRuleResult of the result. Which asserts that only one decision rule result exist.

Returns:

the single decision rule result or null if none exists

Throws:

DmnEngineException - if more than one decision rule 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 DmnDecisionRuleResult. Note that the list may contains less entries than decision rule results if an output does not contain a value for the output name.

Type Parameters:

T - the type of the rule 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 rule results. For every decision rule result a map of the output names and corresponding entries is returned.

Returns:

the list of all entry maps

See Also:

DmnDecisionRuleResult.getEntryMap()

getSingleEntry

<T> T getSingleEntry()

Returns the value of the single entry of the decision rule result. Asserts that only one decision rule 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 rule result or more than one result entry exists

See Also:

getSingleEntryTyped()

getSingleEntryTyped

<T extends org.camunda.bpm.engine.variable.value.TypedValue> T getSingleEntryTyped()

Returns the typed value of the single entry of the decision rule result. Asserts that only one decision rule 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 rule result or more than one result entry exists

See Also:

getSingleEntry()