de.hybris.platform.personalizationfacades.customersegmentation

Interface CustomerSegmentationFacade

All Known Implementing Classes:

DefaultCustomerSegmentationFacade

public interface CustomerSegmentationFacade

Facade for CustomerSegmentation.

Method Summary

Modifier and Type	Method and Description
CustomerSegmentationData	createCustomerSegmentation(CustomerSegmentationData segmentation) Creates customer - segment relation.
void	deleteCustomerSegmentation(java.lang.String segmentation) Deletes customer - segment relation
CustomerSegmentationData	getCustomerSegmentation(java.lang.String segmentationCode) Retrieves customer - segment relation with given code
SearchPageData<CustomerSegmentationData>	getCustomerSegmentations(java.lang.String customerCode, java.lang.String segmentCode, java.lang.String baseSite, SearchPageData<?> pagination) Retrieves customer - segment relations fulfilling provided parameters.
java.util.List<SegmentData>	getSegmentsForCurrentUser() Returns list of segments for current user.
CustomerSegmentationData	updateCustomerSegmentation(CustomerSegmentationData segmentation) Updates data in given customer - segment relation.

Method Detail

getCustomerSegmentations

SearchPageData<CustomerSegmentationData> getCustomerSegmentations(java.lang.String customerCode,
                                                                  java.lang.String segmentCode,
                                                                  java.lang.String baseSite,
                                                                  SearchPageData<?> pagination)

Retrieves customer - segment relations fulfilling provided parameters.

Parameters:

customerCode - - optional customer code

segmentCode - - optional segment code

baseSite - - optional baseSite identifier

pagination - holder of pagination data and sort options

Returns:

list of customer segmentations fulfilling query parameters

getCustomerSegmentation

CustomerSegmentationData getCustomerSegmentation(java.lang.String segmentationCode)

Retrieves customer - segment relation with given code

Parameters:

segmentationCode - - code of relation

Returns:

relation object

createCustomerSegmentation

CustomerSegmentationData createCustomerSegmentation(CustomerSegmentationData segmentation)

Creates customer - segment relation. Provided object should contain identifiers of customer and segment to relate.

Parameters:

segmentation - input data for relation. Segment and customer should exist in system.

Returns:

Created relation

updateCustomerSegmentation

CustomerSegmentationData updateCustomerSegmentation(CustomerSegmentationData segmentation)

Updates data in given customer - segment relation. Code of relation or related items can't be changed.

Parameters:

segmentation - - data for update

Returns:

updated relation

deleteCustomerSegmentation

void deleteCustomerSegmentation(java.lang.String segmentation)

Deletes customer - segment relation

Parameters:

segmentation - id of relation to delete

getSegmentsForCurrentUser

java.util.List<SegmentData> getSegmentsForCurrentUser()

Returns list of segments for current user. Returned segments may be restricted by consents or other means.

Returns:

list of segment for current user

Since:

1808