de.hybris.platform.ruleengine

Interface RuleEngineService

All Known Implementing Classes:

DefaultCommerceRuleEngineService, DefaultPlatformRuleEngineService

public interface RuleEngineService

The interface provides with method that allows initialization and evaluation of rules modules.

Method Summary

Modifier and Type	Method and Description
RuleEngineActionResult	archiveRule(AbstractRuleEngineRuleModel ruleEngineRule) Archives the given rule if it already exists.
RuleEngineActionResult	archiveRule(AbstractRuleEngineRuleModel ruleEngineRule, AbstractRulesModuleModel rulesModule) Archives the given rule if it already exists.
RuleEvaluationResult	evaluate(RuleEvaluationContext context) Executes rule evaluation for given RuleEvaluationContext.
AbstractRuleEngineRuleModel	getRuleForCode(String code) Finds AbstractRuleEngineRuleModel for given code.
AbstractRuleEngineRuleModel	getRuleForUuid(String uuid) Finds AbstractRuleEngineRuleModel for given uuid.
AbstractRulesModuleModel	getRuleModuleForRule(AbstractRuleEngineRuleModel rule) Finds AbstractRulesModuleModel by corresponding AbstractRuleEngineRuleModel.
RuleEngineActionResult	initialize(AbstractRulesModuleModel module) Initializes the given rules module and propagates a RuleEngineInitializedEvent to other nodes.
RuleEngineActionResult	initialize(AbstractRulesModuleModel module, boolean propagateToOtherNodes) Deprecated. since 6.3. Please use initialize method instead
RuleEngineActionResult	initialize(AbstractRulesModuleModel module, String deployedMvnVersion, boolean propagateToOtherNodes) Initializes the given rules module (and if propagateToOtherNodes is set to true propagates a RuleEngineInitializedEvent to other nodes).
List<RuleEngineActionResult>	initializeAllRulesModules() Initializes all AbstractRulesModuleModels that are marked as active (in case of cluster mode - on all the nodes).
List<RuleEngineActionResult>	initializeAllRulesModules(boolean propagateToOtherNodes) Initializes all AbstractRulesModuleModels that are marked as active.
RuleEngineActionResult	updateEngineRule(AbstractRuleEngineRuleModel ruleEngineRule) Updates the given rule if it already exists and returns true if update was successful.
RuleEngineActionResult	updateEngineRule(AbstractRuleEngineRuleModel ruleEngineRule, AbstractRulesModuleModel rulesModule) Updates the given rule if it already exists.

Method Detail

evaluate

RuleEvaluationResult evaluate(RuleEvaluationContext context)

Executes rule evaluation for given RuleEvaluationContext. Executes all rules contained within the context

Parameters:

context - the rule engine context containing data about rule engine execution

Returns:

results of rule engine execution

initialize

@Deprecated
RuleEngineActionResult initialize(AbstractRulesModuleModel module,
                                              boolean propagateToOtherNodes)

Deprecated. since 6.3. Please use initialize method instead

Initializes the given rules module (and if propagateToOtherNodes is set to true propagates a RuleEngineInitializedEvent to other nodes).

Parameters:

module - the module to be initialized

propagateToOtherNodes - if true propagates a RuleEngineInitializedEvent to other nodes.

Returns:

the result of the initialize action (use RuleEngineActionResult.isActionFailed() to check if the action succeeded)

initialize

RuleEngineActionResult initialize(AbstractRulesModuleModel module,
                                  String deployedMvnVersion,
                                  boolean propagateToOtherNodes)

Initializes the given rules module (and if propagateToOtherNodes is set to true propagates a RuleEngineInitializedEvent to other nodes).

Parameters:

module - the module to be initialized

deployedMvnVersion - currently deployed mvn version of the rule engine module

propagateToOtherNodes - if true propagates a RuleEngineInitializedEvent to other nodes.

Returns:

the result of the initialize action (use RuleEngineActionResult.isActionFailed() to check if the action succeeded)

initialize

RuleEngineActionResult initialize(AbstractRulesModuleModel module)

Initializes the given rules module and propagates a RuleEngineInitializedEvent to other nodes.

Parameters:

module - the module to be initialized

Returns:

the result of the initialize action (use RuleEngineActionResult.isActionFailed() to check if the action succeeded)

initializeAllRulesModules

List<RuleEngineActionResult> initializeAllRulesModules()

Initializes all AbstractRulesModuleModels that are marked as active (in case of cluster mode - on all the nodes).

Returns:

the results of the initialize action (use RuleEngineActionResult.isActionFailed() to check if the action succeeded)

initializeAllRulesModules

List<RuleEngineActionResult> initializeAllRulesModules(boolean propagateToOtherNodes)

Initializes all AbstractRulesModuleModels that are marked as active.

Parameters:

propagateToOtherNodes - if true on all the nodes of cluster

Returns:

the activation results

updateEngineRule

RuleEngineActionResult updateEngineRule(AbstractRuleEngineRuleModel ruleEngineRule)

Updates the given rule if it already exists and returns true if update was successful.

Parameters:

ruleEngineRule - Rule to be updated

Returns:

the result of the update action (use RuleEngineActionResult.isActionFailed() to check if the action succeeded)

updateEngineRule

RuleEngineActionResult updateEngineRule(AbstractRuleEngineRuleModel ruleEngineRule,
                                        AbstractRulesModuleModel rulesModule)

Updates the given rule if it already exists.

Parameters:

ruleEngineRule - Rule to be updated

rulesModule - AbstractRulesModuleModel where the Rule be updated

Returns:

the result of the update action (use RuleEngineActionResult.isActionFailed() to check if the action succeeded)

archiveRule

RuleEngineActionResult archiveRule(AbstractRuleEngineRuleModel ruleEngineRule)

Archives the given rule if it already exists.

Parameters:

ruleEngineRule - Rule to be archived

Returns:

the result of the archive action (use RuleEngineActionResult.isActionFailed() to check if the action succeeded)

archiveRule

RuleEngineActionResult archiveRule(AbstractRuleEngineRuleModel ruleEngineRule,
                                   AbstractRulesModuleModel rulesModule)

Archives the given rule if it already exists.

Parameters:

ruleEngineRule - Rule to be archived

rulesModule - AbstractRulesModuleModel where the Rule is archived

Returns:

the result of the archive action (use RuleEngineActionResult.isActionFailed() to check if the action succeeded)

getRuleForCode

AbstractRuleEngineRuleModel getRuleForCode(String code)

Finds AbstractRuleEngineRuleModel for given code.

Parameters:

code - the rule code

Returns:

AbstractRuleEngineRuleModel for given code.

getRuleForUuid

AbstractRuleEngineRuleModel getRuleForUuid(String uuid)

Finds AbstractRuleEngineRuleModel for given uuid.

Parameters:

uuid - the rule uuid

Returns:

AbstractRuleEngineRuleModel for given uuid.

getRuleModuleForRule

AbstractRulesModuleModel getRuleModuleForRule(AbstractRuleEngineRuleModel rule)

Finds AbstractRulesModuleModel by corresponding AbstractRuleEngineRuleModel.

Parameters:

rule - the AbstractRuleEngineRuleModel

Returns:

AbstractRulesModuleModel by corresponding AbstractRuleEngineRuleModel