de.hybris.platform.personalizationservices.segment

Interface CxSegmentService

All Known Implementing Classes:

DefaultCxSegmentService

public interface CxSegmentService

Service for operations on cxSegment models

Method Summary

Modifier and Type	Method and Description
Optional<CxSegmentModel>	getSegment(String code) Retrieves segment with given code
SearchResult<CxSegmentModel>	getSegments(Map<String,String> params, int startPosition, int count) Retrieves segments
Collection<CxSegmentModel>	getSegmentsForCodes(Collection<String> codes) Retrieves all segments of given user.
Collection<CxSegmentModel>	getSegmentsFromUser(UserModel user) Retrieves all segments of given user.
Collection<UserModel>	getUsersFromSegment(CxSegmentModel segment) Retrieves all users related to this segment
SearchResult<CxUserToSegmentModel>	getUserToSegmentModel(UserModel user, CxSegmentModel segment, int startPosition, int count) Retrieves relation object between user and segment.
void	updateUserSegments(UserModel user) Updates segments for given user.

Method Detail

getSegment

Optional<CxSegmentModel> getSegment(String code)

Retrieves segment with given code

Parameters:

code - identifier of segment

Returns:

segment with given code of optional.empty if not found

getSegments

SearchResult<CxSegmentModel> getSegments(Map<String,String> params,
                                         int startPosition,
                                         int count)

Retrieves segments

Parameters:

params - parameters for filtering

startPosition - start position for paginated results

count - how many results should be on page

Returns:

List of all segments. Empty list if no segments were found.

getUsersFromSegment

Collection<UserModel> getUsersFromSegment(CxSegmentModel segment)

Retrieves all users related to this segment

Parameters:

segment - for which users should be retrieved

Returns:

Collection of users. Empty list if no users are related to this segment.

getSegmentsFromUser

Collection<CxSegmentModel> getSegmentsFromUser(UserModel user)

Retrieves all segments of given user.

Parameters:

user - for which segments should be retrieved

Returns:

Collection of segments. Empty list if no segments are related to given user.

getUserToSegmentModel

SearchResult<CxUserToSegmentModel> getUserToSegmentModel(UserModel user,
                                                         CxSegmentModel segment,
                                                         int startPosition,
                                                         int count)

Retrieves relation object between user and segment. user and segment may be null. In such case this parameter is ignored and paginated collection of relations is returned.

Parameters:

user - defining one side of relation - may be null which means all users

segment - defining other side of relation - may be null which means all segments

startPosition - start position for paginated results

count - how many results should be on page

Returns:

collection of relation between given user and segment. Empty if no relation was found.

updateUserSegments

void updateUserSegments(UserModel user)

Updates segments for given user.

Parameters:

user -

getSegmentsForCodes

Collection<CxSegmentModel> getSegmentsForCodes(Collection<String> codes)

Retrieves all segments of given user.

Parameters:

codes - list of identifiers of segments

Returns:

Collection of segments. Empty list if no segments are related to given user.