de.hybris.platform.btg.segment.impl

Class DefaultSegmentEvaluator

java.lang.Object

de.hybris.platform.btg.segment.impl.DefaultSegmentEvaluator

All Implemented Interfaces:

SegmentEvaluator

public class DefaultSegmentEvaluator
extends java.lang.Object
implements SegmentEvaluator

Constructor Summary

Constructors

Constructor and Description
DefaultSegmentEvaluator()

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
protected java.lang.Boolean	earlyEvaluate(UserModel user, BTGSegmentModel segment, BTGEvaluationContext context, BTGSegmentResultModel lastSegmentResult) This method allows to make evaluation based on some predefined rules, without actually trying to do full evaluation.
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.
boolean	isStoreFirstNegativeResult()
void	performOutputAction(UserModel user, BTGSegmentModel segment, BTGEvaluationContext evaluationContext) Perform output action for given segment and user
void	setActionService(ActionService actionService)
void	setBtgDao(BTGDao btgDao)
void	setBtgInvalidationDataContainer(BTGInvalidationDataContainer<BTGSegmentResultModel> invalidationDataContainer)
void	setModelService(ModelService modelService)
void	setOutputActionContextProvider(OutputActionContextProvider outputActionContextProvider)
void	setRuleEvaluatorRegistry(RuleEvaluatorRegistry ruleEvaluatorRegistry)
void	setSegmentResult(boolean newResult, UserModel user, BTGSegmentModel segment, boolean performOutputAction, BTGEvaluationContext evaluationContext, java.lang.String jaloSessionId, boolean forced) saves a result for segment
void	setStoreFirstNegativeResult(boolean storeFirstNegativeResult)

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultSegmentEvaluator

public DefaultSegmentEvaluator()

Method Detail

earlyEvaluate

protected java.lang.Boolean earlyEvaluate(UserModel user,
                                          BTGSegmentModel segment,
                                          BTGEvaluationContext context,
                                          BTGSegmentResultModel lastSegmentResult)

This method allows to make evaluation based on some predefined rules, without actually trying to do full evaluation.

Returns:

Any non-null value is the evaluation result. Null value means that evaluation should proceed as normal.

evaluate

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

Description copied from interface: SegmentEvaluator

Evaluates Segment for given user, scope and evaluation method

Specified by:

evaluate in interface SegmentEvaluator

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

public void setSegmentResult(boolean newResult,
                             UserModel user,
                             BTGSegmentModel segment,
                             boolean performOutputAction,
                             BTGEvaluationContext evaluationContext,
                             java.lang.String jaloSessionId,
                             boolean forced)

Description copied from interface: SegmentEvaluator

saves a result for segment

Specified by:

setSegmentResult in interface SegmentEvaluator

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

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

Description copied from interface: SegmentEvaluator

Perform output action for given segment and user

Specified by:

performOutputAction in interface SegmentEvaluator

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

setBtgDao

public void setBtgDao(BTGDao btgDao)

setRuleEvaluatorRegistry

public void setRuleEvaluatorRegistry(RuleEvaluatorRegistry ruleEvaluatorRegistry)

setActionService

public void setActionService(ActionService actionService)

setModelService

public void setModelService(ModelService modelService)

setBtgInvalidationDataContainer

public void setBtgInvalidationDataContainer(BTGInvalidationDataContainer<BTGSegmentResultModel> invalidationDataContainer)

checkSegmentForUser

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

Description copied from interface: SegmentEvaluator

Return last segment evaluation (or forced) result for user

Specified by:

checkSegmentForUser in interface SegmentEvaluator

Parameters:

user - user to get evaluation result

segment - segment which we want to check

context - YTODO

invalidateSegment

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

Description copied from interface: SegmentEvaluator

Invalidates latest segment results for given user.

Specified by:

invalidateSegment in interface SegmentEvaluator

Parameters:

user - given user

segment - given segment

context - given context

Returns:

invalidation result true success, otherwise false

setOutputActionContextProvider

public void setOutputActionContextProvider(OutputActionContextProvider outputActionContextProvider)

setStoreFirstNegativeResult

public void setStoreFirstNegativeResult(boolean storeFirstNegativeResult)

isStoreFirstNegativeResult

public boolean isStoreFirstNegativeResult()