de.hybris.platform.btg.services

Interface BTGEvaluationService

All Known Implementing Classes:

DefaultBTGEvaluationService

public interface BTGEvaluationService

BTG evaluation service. Entry point for evaluation of all BTGSegmentModel for a user.

Method Summary

Modifier and Type	Method and Description
void	evaluateAllSegments(UserGroupModel userGroup, CMSSiteModel website, BTGEvaluationContext context, Collection<CatalogVersionModel> catalogVersion) Evaluates for all users in userGroup all active segments for specific website and scope using evaluation method
void	evaluateAllSegments(UserModel user, CMSSiteModel website, BTGEvaluationContext context) Evaluates for user all active segments for specific website and scope using evaluation method
void	evaluateAllSegments(UserModel user, CMSSiteModel website, BTGEvaluationContext context, Collection<CatalogVersionModel> catalogVersion) Evaluates for user all active segments for specific website and scope using evaluation method
void	evaluateAllSegments(UserModel user, List<CMSSiteModel> websites, BTGEvaluationContext context) Evaluates for user all active segments for specific websites and scope using evaluation method
void	evaluateAllSegments(UserModel user, List<CMSSiteModel> websites, BTGEvaluationContext context, Collection<CatalogVersionModel> catalogVersion) Evaluates for user all active segments for specific websites and scope using evaluation method
boolean	evaluateRule(UserModel user, BTGRuleModel rule, BTGEvaluationContext context) Evaluate specified rule for user by using evaluation method and scope
boolean	evaluateSegment(UserModel user, BTGSegmentModel segment, BTGEvaluationContext context) Evaluate specified segment for user by using evaluation method and scope

Method Detail

evaluateAllSegments

void evaluateAllSegments(UserModel user,
                         CMSSiteModel website,
                         BTGEvaluationContext context)
                  throws SegmentEvaluationException

Evaluates for user all active segments for specific website and scope using evaluation method

Parameters:

user - User for which the segments should be evaluated

website - Evaluate segments for this website

context - Context object containing settings for the evaluation

Throws:

SegmentEvaluationException

evaluateAllSegments

void evaluateAllSegments(UserModel user,
                         CMSSiteModel website,
                         BTGEvaluationContext context,
                         Collection<CatalogVersionModel> catalogVersion)
                  throws SegmentEvaluationException

Evaluates for user all active segments for specific website and scope using evaluation method

Parameters:

user - User for which the segments should be evaluated

website - Evaluate segments for this website

context - Context object containing settings for the evaluation

catalogVersion - catalog version for which segments are evaluated

Throws:

SegmentEvaluationException

evaluateAllSegments

void evaluateAllSegments(UserGroupModel userGroup,
                         CMSSiteModel website,
                         BTGEvaluationContext context,
                         Collection<CatalogVersionModel> catalogVersion)
                  throws SegmentEvaluationException

Evaluates for all users in userGroup all active segments for specific website and scope using evaluation method

Parameters:

userGroup - userGroup for which the segments should be evaluated

website - Evaluate segments for this website

context - Context object containing settings for the evaluation

catalogVersion - catalog version for which segments are evaluated

Throws:

SegmentEvaluationException

evaluateAllSegments

void evaluateAllSegments(UserModel user,
                         List<CMSSiteModel> websites,
                         BTGEvaluationContext context)
                  throws SegmentEvaluationException

Evaluates for user all active segments for specific websites and scope using evaluation method

Parameters:

user - User for which the segments should be evaluated

websites - Evaluate segments for those websites

context - Context object containing settings for the evaluation

Throws:

SegmentEvaluationException

evaluateAllSegments

void evaluateAllSegments(UserModel user,
                         List<CMSSiteModel> websites,
                         BTGEvaluationContext context,
                         Collection<CatalogVersionModel> catalogVersion)
                  throws SegmentEvaluationException

Evaluates for user all active segments for specific websites and scope using evaluation method

Parameters:

user - User for which the segments should be evaluated

websites - Evaluate segments for those websites

context - Context object containing settings for the evaluation

catalogVersion - catalog version for which segments are evaluated

Throws:

SegmentEvaluationException

evaluateSegment

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

Evaluate specified segment for user by using evaluation method and scope

Parameters:

user - User that can fulfilled segment

segment - Segment we are checking

context - Context object containing settings for the evaluation

Returns:

result of processing

Throws:

SegmentEvaluationException

evaluateRule

boolean evaluateRule(UserModel user,
                     BTGRuleModel rule,
                     BTGEvaluationContext context)
              throws RuleEvaluationException

Evaluate specified rule for user by using evaluation method and scope

Parameters:

user - User that can fulfilled segment

rule - Rule we are checking

context - Context object containing settings for the evaluation

Returns:

result of processing

Throws:

RuleEvaluationException