de.hybris.platform.btg.rule

Interface RuleEvaluator<T extends BTGRuleModel>

All Known Implementing Classes:

DefaultRuleEvaluator, IgnoreInvalidatedRuleEvaluator

public interface RuleEvaluator<T extends BTGRuleModel>

Rule evaluator takes all conditions from the rule and returns true if all of them are fulfilled for the context user.
Default implementation is registered in the spring context as 'defaultRuleEvaluator'.

Method Summary

Modifier and Type	Method and Description
BTGRuleResultModel	checkRuleForUser(UserModel user, BTGRuleModel rule, BTGEvaluationContext context) return last rule evaluation/forced result for user
boolean	evaluate(UserModel user, T rule, BTGEvaluationContext context) Evaluates to true is all conditions in BTGRuleModel.getConditions() are fulfilled for the user.
boolean	invalidateRule(UserModel user, BTGRuleModel rule, BTGEvaluationContext context) Invalidates latest rule results for given user and rule.
void	setRuleResult(UserModel user, T rule, BTGResultScope resultScope, boolean result, String jaloSessionId, boolean forced) Store rule result for Rule.

Method Detail

evaluate

boolean evaluate(UserModel user,
                 T rule,
                 BTGEvaluationContext context)
          throws RuleEvaluationException

Evaluates to true is all conditions in BTGRuleModel.getConditions() are fulfilled for the user.

Parameters:

user - - user for which the rule is evaluated

rule - - the rule to evaluate

context - - context object containing settings for the evaluation

Throws:

RuleEvaluationException

setRuleResult

void setRuleResult(UserModel user,
                   T rule,
                   BTGResultScope resultScope,
                   boolean result,
                   String jaloSessionId,
                   boolean forced)

Store rule result for Rule. Useful routine to manually change evaluation result

Parameters:

user - - user for which the rule is evaluated

rule - - the rule to evaluate

resultScope - - the ResulScope

result - - evaluation result.

forced - if true results will be forced otherwise not

checkRuleForUser

BTGRuleResultModel checkRuleForUser(UserModel user,
                                    BTGRuleModel rule,
                                    BTGEvaluationContext context)

return last rule evaluation/forced result for user

Parameters:

user - user to get evaluation result

rule - rule which we want to check

context - YTODO

invalidateRule

boolean invalidateRule(UserModel user,
                       BTGRuleModel rule,
                       BTGEvaluationContext context)

Invalidates latest rule results for given user and rule.

Parameters:

user - given user

rule - given rule

context - given context

Returns:

invalidation result true success, otherwise false