de.hybris.platform.personalizationservices.segment

Interface CxUserSegmentService

All Known Implementing Classes:

DefaultCxUserSegmentService

public interface CxUserSegmentService

Service manages user segments

Since:

6.7

Method Summary

Modifier and Type	Method and Description
void	addUserSegments(UserModel user, java.util.Collection<CxUserToSegmentModel> userSegments) Extend existing user segments
java.util.Collection<CxUserToSegmentModel>	getUserSegments(UserModel user) Method returns user segment relations
java.util.Collection<CxUserToSegmentModel>	getUserSegments(UserModel user, BaseSiteModel baseSite) Method returns user segment relations
void	removeUserSegments(UserModel user, java.util.Collection<CxUserToSegmentModel> userSegmentsToRemove) Remove user segments from existing list
void	setUserSegments(UserModel user, BaseSiteModel baseSite, java.util.Collection<CxUserToSegmentModel> userSegments) Save user to segment relations in database.
void	setUserSegments(UserModel user, BaseSiteModel baseSite, java.util.Collection<CxUserToSegmentModel> userSegments, CxCalculationContext context) Save user to segment relations in database.
void	setUserSegments(UserModel user, java.util.Collection<CxUserToSegmentModel> userSegments) Save user to segment relations in database.

Method Detail

getUserSegments

java.util.Collection<CxUserToSegmentModel> getUserSegments(UserModel user)

Method returns user segment relations

Parameters:

user - User model

Returns:

User segments

getUserSegments

java.util.Collection<CxUserToSegmentModel> getUserSegments(UserModel user,
                                                           BaseSiteModel baseSite)

Method returns user segment relations

Parameters:

user - User model

baseSite - BaseSite model

Returns:

User segments

setUserSegments

void setUserSegments(UserModel user,
                     java.util.Collection<CxUserToSegmentModel> userSegments)

Save user to segment relations in database.
Do nothing for anonymous user

Parameters:

user - User to which segments should be assigned

userSegments - Collection of user segments

setUserSegments

void setUserSegments(UserModel user,
                     BaseSiteModel baseSite,
                     java.util.Collection<CxUserToSegmentModel> userSegments)

Save user to segment relations in database.
Do nothing for anonymous user

Parameters:

user - User to which segments should be assigned

baseSite - BaseSite related to user segments

userSegments - Collection of user segments

setUserSegments

void setUserSegments(UserModel user,
                     BaseSiteModel baseSite,
                     java.util.Collection<CxUserToSegmentModel> userSegments,
                     CxCalculationContext context)

Save user to segment relations in database.
Do nothing for anonymous user

Parameters:

user - User to which segments should be assigned

baseSite - BaseSite related to user segments

userSegments - Collection of user segments

context - Context containing additional parameters e.g segment providers

Since:

1811

addUserSegments

void addUserSegments(UserModel user,
                     java.util.Collection<CxUserToSegmentModel> userSegments)

Extend existing user segments

Parameters:

user - User to which segments should be added

userSegments - Collection of user segments which should be added to existing one

removeUserSegments

void removeUserSegments(UserModel user,
                        java.util.Collection<CxUserToSegmentModel> userSegmentsToRemove)

Remove user segments from existing list

Parameters:

user - User from which segments should be removed

userSegmentsToRemove - Collection of user segments which should be removed from existing one