de.hybris.platform.ruleengineservices.rule.evaluation

Interface RuleActionContext

All Known Implementing Classes:

DefaultDroolsRuleActionContext

public interface RuleActionContext

This interface represents the context for actions applied during rule evaluation.

Method Summary

Modifier and Type	Method and Description
CartRAO	getCartRao() Get cart RAO
Object	getDelegate() Returns a rule engine specific context object.
String	getMetaData(String key) Returns the rule's meta-data for the given key (or null).
RuleEngineResultRAO	getRuleEngineResultRao() Get rule engine result RAO
Map<String,Object>	getRuleMetadata() get rule metadata
String	getRuleName() Get the name of the rule
<T> T	getValue(Class<T> type) Returns the value for a specific type from the default variables container.
<T> T	getValue(Class<T> type, String... path) Returns the value for a specific type and variables container.
<T> Set<T>	getValues(Class<T> type) Returns the values for a specific type from the default variables container.
<T> Set<T>	getValues(Class<T> type, String... path) Returns the values for a specific type and variables container.
void	insertFacts(Collection facts) Insert the facts in a collection to a context
void	insertFacts(Object... facts) Insert the facts in an array to a context
void	updateFacts(Object... facts) Update the facts in a context

Method Detail

getMetaData

String getMetaData(String key)

Returns the rule's meta-data for the given key (or null). Calls toString() on the meta-data object.

Parameters:

key -

Returns:

the string representation of the meta-data (or null)

getValue

<T> T getValue(Class<T> type)

Returns the value for a specific type from the default variables container. If more than one value is found, the first one is returned.

Parameters:

type - - the type

Returns:

the value or null if no value is found for the given type

getValues

<T> Set<T> getValues(Class<T> type)

Returns the values for a specific type from the default variables container.

Parameters:

type - - the type

Returns:

the values or an empty set if no value is found for the given type

getValue

<T> T getValue(Class<T> type,
               String... path)

Returns the value for a specific type and variables container. If more than one value is found, the first one is returned.

Parameters:

type - - the type

path - - the path for the variables container

Returns:

the value or null if no value is found for the given type

getValues

<T> Set<T> getValues(Class<T> type,
                     String... path)

Returns the values for a specific type and variables container.

Parameters:

type - - the type

path - - the path for the variables container

Returns:

the values or an empty set if no value is found for the given type

insertFacts

void insertFacts(Object... facts)

Insert the facts in an array to a context

Parameters:

facts - - the array of facts

insertFacts

void insertFacts(Collection facts)

Insert the facts in a collection to a context

Parameters:

facts - - the collection of facts

updateFacts

void updateFacts(Object... facts)

Update the facts in a context

Parameters:

facts - - the array of facts

getCartRao

CartRAO getCartRao()

Get cart RAO

getRuleEngineResultRao

RuleEngineResultRAO getRuleEngineResultRao()

Get rule engine result RAO

getRuleName

String getRuleName()

Get the name of the rule

getRuleMetadata

Map<String,Object> getRuleMetadata()

get rule metadata

getDelegate

Object getDelegate()

Returns a rule engine specific context object.