de.hybris.platform.btg.services

Interface BTGResultService

All Known Implementing Classes:

DefaultBTGResultService

public interface BTGResultService

BTG result service. Contains methods for checking and managing evaluation results.

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> catalogVersions) 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	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	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	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.

Method Detail

isFulfilled

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

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

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

isFulfilled

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

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

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

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

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

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

setSegmentResult

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

Manually marks a segment fulfilled/not fulfilled.

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

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.

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

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

Manually marks a rule fulfilled/not fulfilled.

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

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

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

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

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

Manually marks a condition fulfilled/not fulfilled.

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

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

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

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

moveSessionResults

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). This is used e.g. for transferring all evaluation results of the anonymous user to the proper user when the user logs in.

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)

checkSegmentForUser

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

Checks the UserToBTGSegmenRelation for the given user and segment

Parameters:

user -

segment -

context - YTODO

Returns:

true if user had fulfilled already the segment

checkRuleForUser

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

Checks the UserToBTGRuleRelation for the given user and rule

Parameters:

user -

rule -

context - YTODO

Returns:

true if user had fulfilled already the rule

checkConditionForUser

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

Checks the UserToBTGConditionelation for the given user and rule

Parameters:

user -

condition -

context - YTODO

Returns:

true if user had fulfilled already the condition

invalidateEvaluationResults

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

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.

Parameters:

website - given site

user - given user

context - current context

type - given rule type

invalidateEvaluationResults

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

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.

Parameters:

websites - given sites

user - given user

type - given rule type

context - current context

invalidateEvaluationResults

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

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.

Parameters:

websites - given sites

user - given user

type - given rule type

context - current context

catalogVersions - given catalog versions

invalidateSegment

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

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.

Parameters:

user - given user

segment - current segment

context - current context

type - given rule type