org.camunda.bpm.dmn.engine

Interface DmnDecisionResultEntries

All Superinterfaces:

Map<String,Object>, Serializable

All Known Implementing Classes:

DmnDecisionResultEntriesImpl

public interface DmnDecisionResultEntries
extends Map<String,Object>, Serializable

Represents the output entries (i.e., pairs of output name and value).

In case of a decision with a decision table, the result contains the output entries of a matched rule. Each output value is mapped to the output name attribute. If no name was given then the entry key is null.

Nested Class Summary

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

Map.Entry<K,V>

Method Summary

Modifier and Type	Method and Description
<T> T	getEntry(String name) Returns the value of the result entry for a given output name.
Map<String,Object>	getEntryMap() Returns a map of the result entry values by output name.
Map<String,org.camunda.bpm.engine.variable.value.TypedValue>	getEntryMapTyped() Returns a map of the typed result entry values by output name.
<T extends org.camunda.bpm.engine.variable.value.TypedValue> T	getEntryTyped(String name) Returns the typed value of the result entry for a given output name.
<T> T	getFirstEntry() Returns the value of the first result entry.
<T extends org.camunda.bpm.engine.variable.value.TypedValue> T	getFirstEntryTyped() Returns the typed value of the first result entry.
<T> T	getSingleEntry() Returns the value of the single entry of the decision result.
<T extends org.camunda.bpm.engine.variable.value.TypedValue> T	getSingleEntryTyped() Returns the typed value of the single entry of the decision 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 result entry.

Type Parameters:

T - the type of the result entry

Returns:

the value of the first result entry or null if none exists

See Also:

getFirstEntryTyped()

getFirstEntryTyped

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

Returns the typed value of the first result entry.

Type Parameters:

T - the type of the result entry

Returns:

the typed value of the first result entry or null if none exists

See Also:

getFirstEntry()

getSingleEntry

<T> T getSingleEntry()

Returns the value of the single entry of the decision result. Asserts that the decision result only has one entry.

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 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 result. Asserts that the decision result only has one entry.

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 result entry exists

See Also:

getSingleEntry()

getEntry

<T> T getEntry(String name)

Returns the value of the result entry for a given output name.

Type Parameters:

T - the type of the 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 org.camunda.bpm.engine.variable.value.TypedValue> T getEntryTyped(String name)

Returns the typed value of the result entry for a given output name.

Type Parameters:

T - the type of the 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

Map<String,Object> getEntryMap()

Returns a map of the result entry values by output name.

Returns:

the values of the decision result entries

See Also:

getEntryMapTyped()

getEntryMapTyped

Map<String,org.camunda.bpm.engine.variable.value.TypedValue> getEntryMapTyped()

Returns a map of the typed result entry values by output name.

Returns:

the typed values of the decision result entries

See Also:

getEntryMap()