de.hybris.platform.btg.services.impl

Class DefaultBTGResultService

java.lang.Object

de.hybris.platform.btg.services.impl.DefaultBTGResultService

All Implemented Interfaces:

BTGResultService

public class DefaultBTGResultService
extends java.lang.Object
implements BTGResultService

Constructor Summary

Constructors

Constructor and Description
DefaultBTGResultService()

Method Summary

Modifier and Type	Method and Description
BTGConditionResultModel	checkConditionForUser(UserModel user, BTGConditionModel condition, BTGEvaluationContext context) Checks the UserToBTGConditionelation for the given user and rule
BTGRuleResultModel	checkRuleForUser(UserModel user, BTGRuleModel rule, BTGEvaluationContext context) Checks the UserToBTGRuleRelation for the given user and rule
BTGSegmentResultModel	checkSegmentForUser(UserModel user, BTGSegmentModel segment, BTGEvaluationContext context) Checks the UserToBTGSegmenRelation for the given user and segment
void	invalidateEvaluationResults(CMSSiteModel website, UserModel user, BTGEvaluationContext context, BTGRuleType type) Invalidates evaluation results for given site and user.
void	invalidateEvaluationResults(java.util.Collection<CMSSiteModel> websites, UserModel user, BTGEvaluationContext context, BTGRuleType type) Invalidates evaluation results for given site and user.
void	invalidateEvaluationResults(java.util.Collection<CMSSiteModel> websites, UserModel user, BTGEvaluationContext context, BTGRuleType type, java.util.Collection<CatalogVersionModel> catalogVersion) Invalidates evaluation results for given site and user.
void	invalidateSegment(UserModel user, BTGSegmentModel segment, BTGEvaluationContext context, BTGRuleType type) Invalidates evaluation results in segment for given user.
boolean	isFulfilled(UserModel user, BTGConditionModel condition, BTGEvaluationContext context) Checks if the given condition is fulfilled for the given user.
boolean	isFulfilled(UserModel user, BTGRuleModel rule, BTGEvaluationContext context) Checks if the given rule is fulfilled for the given user.
boolean	isFulfilled(UserModel user, BTGSegmentModel segment, BTGEvaluationContext context) Checks if the given segment is fulfilled for the given user.
void	moveSessionResults(UserModel src, BTGEvaluationContext srcContext, UserModel dest, BTGEvaluationContext destContext) Moves all evaluation results computed within given session (session ID is stored in the srcContext) for a given user (src) to other session (destContext) and other user (dest).
void	setBtgDao(BTGDao btgDao)
void	setCatalogVersionService(CatalogVersionService catalogVersionService)
void	setConditionEvaluatorRegistry(ConditionEvaluatorRegistry conditionEvaluatorRegistry)
void	setConditionResult(boolean result, UserModel user, BTGConditionModel condition, BTGEvaluationContext context) Manually marks a condition fulfilled/not fulfilled.
void	setConditionResult(boolean result, UserModel user, BTGConditionModel condition, BTGEvaluationContext context, boolean forced) Manually marks a condition fulfilled/not fulfilled and forced/not forced.
void	setRuleEvaluatorRegistry(RuleEvaluatorRegistry ruleEvaluatorRegistry)
void	setRuleResult(boolean result, UserModel user, BTGRuleModel rule, BTGEvaluationContext context) Manually marks a rule fulfilled/not fulfilled.
void	setRuleResult(boolean result, UserModel user, BTGRuleModel rule, BTGEvaluationContext context, boolean forced) Manually marks a rule fulfilled/not fulfilled and forced/not forced.
void	setSegmentEvaluatorRegistry(SegmentEvaluatorRegistry segmentEvaluatorRegistry)
void	setSegmentResult(boolean result, UserModel user, BTGSegmentModel segment, BTGEvaluationContext context, boolean performOutputAction) Manually marks a segment fulfilled/not fulfilled.
void	setSegmentResult(boolean result, UserModel user, BTGSegmentModel segment, BTGEvaluationContext context, boolean performOutputAction, boolean forced) Manually marks a segment fulfilled/not fulfilled and forced/not forced.
void	setSegmentService(SegmentService segmentService)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DefaultBTGResultService

public DefaultBTGResultService()

Method Detail

moveSessionResults

public void moveSessionResults(UserModel src,
                               BTGEvaluationContext srcContext,
                               UserModel dest,
                               BTGEvaluationContext destContext)

Description copied from interface: BTGResultService

Moves all evaluation results computed within given session (session ID is stored in the srcContext) for a given user (src) to other session (destContext) and other user (dest). This is used e.g. for transferring all evaluation results of the anonymous user to the proper user when the user logs in.

Specified by:

moveSessionResults in interface BTGResultService

Parameters:

src - the source user

srcContext - the source evaluation context (contains the source session ID, see BTGEvaluationContext)

dest - the destination user

destContext - the destination evaluation context (contains the destination session ID, see BTGEvaluationContext)

setSegmentResult

public void setSegmentResult(boolean result,
                             UserModel user,
                             BTGSegmentModel segment,
                             BTGEvaluationContext context,
                             boolean performOutputAction)

Description copied from interface: BTGResultService

Manually marks a segment fulfilled/not fulfilled.

Specified by:

setSegmentResult in interface BTGResultService

Parameters:

result - desired result (true = fulfilled, false = not fulfilled)

user - the user to set the segment result for

segment - the segment to set the result for

context - evaluation context to be used. See BTGEvaluationContext for details.

performOutputAction - if set to true the output action of the segment will be triggered, otherwise not

setSegmentResult

public void setSegmentResult(boolean result,
                             UserModel user,
                             BTGSegmentModel segment,
                             BTGEvaluationContext context,
                             boolean performOutputAction,
                             boolean forced)

Description copied from interface: BTGResultService

Manually marks a segment fulfilled/not fulfilled and forced/not forced.

Specified by:

setSegmentResult in interface BTGResultService

Parameters:

result - desired result (true = fulfilled, false = not fulfilled)

user - the user to set the segment result for

segment - the segment to set the result for

context - evaluation context to be used. See BTGEvaluationContext for details.

performOutputAction - if set to true the output action of the segment will be triggered, otherwise not

forced - if set to true the segment results will be forced, otherwise not

setRuleResult

public void setRuleResult(boolean result,
                          UserModel user,
                          BTGRuleModel rule,
                          BTGEvaluationContext context)

Description copied from interface: BTGResultService

Manually marks a rule fulfilled/not fulfilled.

Specified by:

setRuleResult in interface BTGResultService

Parameters:

result - desired result (true = fulfilled, false = not fulfilled)

user - the user to set the rule result for

rule - the rule to set the result for

context - evaluation context to be used. See BTGEvaluationContext for details.

setRuleResult

public void setRuleResult(boolean result,
                          UserModel user,
                          BTGRuleModel rule,
                          BTGEvaluationContext context,
                          boolean forced)

Description copied from interface: BTGResultService

Manually marks a rule fulfilled/not fulfilled and forced/not forced.

Specified by:

setRuleResult in interface BTGResultService

Parameters:

result - desired result (true = fulfilled, false = not fulfilled)

user - the user to set the rule result for

rule - the rule to set the result for

context - evaluation context to be used. See BTGEvaluationContext for details.

setConditionResult

public void setConditionResult(boolean result,
                               UserModel user,
                               BTGConditionModel condition,
                               BTGEvaluationContext context)

Description copied from interface: BTGResultService

Manually marks a condition fulfilled/not fulfilled.

Specified by:

setConditionResult in interface BTGResultService

Parameters:

result - desired result (true = fulfilled, false = not fulfilled)

user - the user to set the condition result for

condition - the condition to set the result for

context - evaluation context to be used. See BTGEvaluationContext for details.

setConditionResult

public void setConditionResult(boolean result,
                               UserModel user,
                               BTGConditionModel condition,
                               BTGEvaluationContext context,
                               boolean forced)

Description copied from interface: BTGResultService

Manually marks a condition fulfilled/not fulfilled and forced/not forced.

Specified by:

setConditionResult in interface BTGResultService

Parameters:

result - desired result (true = fulfilled, false = not fulfilled)

user - the user to set the condition result for

condition - the condition to set the result for

context - evaluation context to be used. See BTGEvaluationContext for details.

forced - if true results will be forced otherwise not

checkConditionForUser

public BTGConditionResultModel checkConditionForUser(UserModel user,
                                                     BTGConditionModel condition,
                                                     BTGEvaluationContext context)

Description copied from interface: BTGResultService

Checks the UserToBTGConditionelation for the given user and rule

Specified by:

checkConditionForUser in interface BTGResultService

context - YTODO

Returns:

true if user had fulfilled already the condition

checkRuleForUser

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

Description copied from interface: BTGResultService

Checks the UserToBTGRuleRelation for the given user and rule

Specified by:

checkRuleForUser in interface BTGResultService

context - YTODO

Returns:

true if user had fulfilled already the rule

checkSegmentForUser

public BTGSegmentResultModel checkSegmentForUser(UserModel user,
                                                 BTGSegmentModel segment,
                                                 BTGEvaluationContext context)

Description copied from interface: BTGResultService

Checks the UserToBTGSegmenRelation for the given user and segment

Specified by:

checkSegmentForUser in interface BTGResultService

context - YTODO

Returns:

true if user had fulfilled already the segment

isFulfilled

public boolean isFulfilled(UserModel user,
                           BTGConditionModel condition,
                           BTGEvaluationContext context)

Description copied from interface: BTGResultService

Checks if the given condition is fulfilled for the given user. Condition is not evaluated by calling this method.

Specified by:

isFulfilled in interface BTGResultService

Parameters:

user - the user to check the condition for

condition - the condition to be checked

context - evaluation context to be used for this check. See BTGEvaluationContext for details.

Returns:

true if condition is fulfilled, false otherwise

isFulfilled

public boolean isFulfilled(UserModel user,
                           BTGRuleModel rule,
                           BTGEvaluationContext context)

Description copied from interface: BTGResultService

Checks if the given rule is fulfilled for the given user. Rule is not evaluated by calling this method.

Specified by:

isFulfilled in interface BTGResultService

Parameters:

user - the user to check the rule for

rule - the rule to be checked

context - evaluation context to be used for this check. See BTGEvaluationContext for details.

Returns:

true if rule is fulfilled, false otherwise

isFulfilled

public boolean isFulfilled(UserModel user,
                           BTGSegmentModel segment,
                           BTGEvaluationContext context)

Description copied from interface: BTGResultService

Checks if the given segment is fulfilled for the given user. Segment is not evaluated by calling this method.

Specified by:

isFulfilled in interface BTGResultService

Parameters:

user - the user to check the segment for

segment - the segment to be checked

context - evaluation context to be used for this check. See BTGEvaluationContext for details.

Returns:

true if segment is fulfilled, false otherwise

setRuleEvaluatorRegistry

public void setRuleEvaluatorRegistry(RuleEvaluatorRegistry ruleEvaluatorRegistry)

Parameters:

ruleEvaluatorRegistry - the ruleEvaluatorRegistry to set

setConditionEvaluatorRegistry

public void setConditionEvaluatorRegistry(ConditionEvaluatorRegistry conditionEvaluatorRegistry)

Parameters:

conditionEvaluatorRegistry - the conditionEvaluatorRegistry to set

setCatalogVersionService

public void setCatalogVersionService(CatalogVersionService catalogVersionService)

Parameters:

catalogVersionService - the catalogVersionService to set

setSegmentEvaluatorRegistry

public void setSegmentEvaluatorRegistry(SegmentEvaluatorRegistry segmentEvaluatorRegistry)

Parameters:

segmentEvaluatorRegistry - the segmentEvaluatorRegistry to set

setSegmentService

public void setSegmentService(SegmentService segmentService)

Parameters:

segmentService - the segmentService to set

invalidateEvaluationResults

public void invalidateEvaluationResults(CMSSiteModel website,
                                        UserModel user,
                                        BTGEvaluationContext context,
                                        BTGRuleType type)

Description copied from interface: BTGResultService

Invalidates evaluation results for given site and user.

Note:
When type parameter is specified only those rules will be invalidated, otherwise (when is null) all types of rules will be invalidated.

Specified by:

invalidateEvaluationResults in interface BTGResultService

Parameters:

website - given site

user - given user

context - current context

type - given rule type

invalidateEvaluationResults

public void invalidateEvaluationResults(java.util.Collection<CMSSiteModel> websites,
                                        UserModel user,
                                        BTGEvaluationContext context,
                                        BTGRuleType type)

Description copied from interface: BTGResultService

Invalidates evaluation results for given site and user.

Note:
When type parameter is specified only those rules will be invalidated, otherwise (when is null) all types of rules will be invalidated.

Specified by:

invalidateEvaluationResults in interface BTGResultService

Parameters:

websites - given sites

user - given user

context - current context

type - given rule type

invalidateEvaluationResults

public void invalidateEvaluationResults(java.util.Collection<CMSSiteModel> websites,
                                        UserModel user,
                                        BTGEvaluationContext context,
                                        BTGRuleType type,
                                        java.util.Collection<CatalogVersionModel> catalogVersion)

Description copied from interface: BTGResultService

Invalidates evaluation results for given site and user.

Note:
When type parameter is specified only those rules will be invalidated, otherwise (when is null) all types of rules will be invalidated.

Specified by:

invalidateEvaluationResults in interface BTGResultService

Parameters:

websites - given sites

user - given user

context - current context

type - given rule type

catalogVersion - given catalog versions

invalidateSegment

public void invalidateSegment(UserModel user,
                              BTGSegmentModel segment,
                              BTGEvaluationContext context,
                              BTGRuleType type)

Description copied from interface: BTGResultService

Invalidates evaluation results in segment for given user.

Note:
When type parameter is specified only those rules will be invalidated, otherwise (when is null) all types of rules will be invalidated.

Specified by:

invalidateSegment in interface BTGResultService

Parameters:

user - given user

segment - current segment

context - current context

type - given rule type

setBtgDao

public void setBtgDao(BTGDao btgDao)