org.camunda.bpm.dmn.engine
Interface DmnDecisionRuleResult

All Superinterfaces:

Map<String,Object>, Serializable

All Known Implementing Classes:

DmnDecisionRuleResultImpl

public interface DmnDecisionRuleResult
extends Map<String,Object>, 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

Map.Entry<K,V>

Method Summary

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

Methods inherited from interface java.util.Map

clear, containsKey, containsValue, entrySet, equals, get, hashCode, isEmpty, keySet, put, putAll, remove, 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 org.camunda.bpm.engine.variable.value.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 org.camunda.bpm.engine.variable.value.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(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 org.camunda.bpm.engine.variable.value.TypedValue> T getEntryTyped(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

Map<String,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

Map<String,org.camunda.bpm.engine.variable.value.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()