de.hybris.platform.btg.segment

Interface SegmentEvaluator

All Known Implementing Classes:

DefaultSegmentEvaluator, IgnoreInvalidatedSegmentEvaluator

public interface SegmentEvaluator

Implementations of this interface evaluate a segment for a user and perform the output action if the user should belong to a segment. Usually it means that all rules of a segments are evaluated and if all rules are fulfilled then the user is put into the segment.

Method Summary

Modifier and Type	Method and Description
BTGSegmentResultModel	checkSegmentForUser(UserModel user, BTGSegmentModel segment, BTGEvaluationContext context) Return last segment evaluation (or forced) result for user
boolean	evaluate(UserModel user, BTGSegmentModel segment, BTGEvaluationContext context) Evaluates Segment for given user, scope and evaluation method
boolean	invalidateSegment(UserModel user, BTGSegmentModel segment, BTGEvaluationContext context, BTGRuleType ruleType) Invalidates latest segment results for given user.
void	performOutputAction(UserModel user, BTGSegmentModel segment, BTGEvaluationContext evaluationContext) Perform output action for given segment and user
void	setSegmentResult(boolean result, UserModel user, BTGSegmentModel segment, boolean performOutputAction, BTGEvaluationContext evaluationContext, String jaloSessionId, boolean forced) saves a result for segment

Method Detail

evaluate

boolean evaluate(UserModel user,
                 BTGSegmentModel segment,
                 BTGEvaluationContext context)
          throws SegmentEvaluationException

Evaluates Segment for given user, scope and evaluation method

Parameters:

user - User that is passed to evaluate segment for him

segment - Segment that will be evaluated for user

context - Context object containing settings for the evaluation

Returns:

evaluation result

Throws:

SegmentEvaluationException

setSegmentResult

void setSegmentResult(boolean result,
                      UserModel user,
                      BTGSegmentModel segment,
                      boolean performOutputAction,
                      BTGEvaluationContext evaluationContext,
                      String jaloSessionId,
                      boolean forced)

saves a result for segment

Parameters:

user - User who will be added to segment

segment - Segment that will be user add for

performOutputAction - if true output actions for service are fired

evaluationContext - Context object containing settings for the evaluation

jaloSessionId - session identifier

forced - if true results will be forced otherwise not

performOutputAction

void performOutputAction(UserModel user,
                         BTGSegmentModel segment,
                         BTGEvaluationContext evaluationContext)

Perform output action for given segment and user

Parameters:

user - for him action will be performed

segment - segment that tell us witch action have to be performed

evaluationContext - the evaluation context for additional informations

checkSegmentForUser

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

Return last segment evaluation (or forced) result for user

Parameters:

user - user to get evaluation result

segment - segment which we want to check

context - YTODO

invalidateSegment

boolean invalidateSegment(UserModel user,
                          BTGSegmentModel segment,
                          BTGEvaluationContext context,
                          BTGRuleType ruleType)

Invalidates latest segment results for given user.

Parameters:

user - given user

segment - given segment

context - given context

Returns:

invalidation result true success, otherwise false