Package de.hybris.platform.personalizationfacades.segmentation

Interface SegmentationHelper

All Known Implementing Classes:

DefaultSegmentationHelper

public interface SegmentationHelper

Field Summary

Fields

Modifier and Type	Field	Description
static int	BASESITE_INDEX
static int	CUSTOMER_INDEX
static int	NUMBER_OF_CODE_INDEXES
static int	PROVIDER_INDEX
static int	SEGMENT_INDEX

Method Summary

Modifier and Type	Method	Description
java.lang.String	getCustomerSegmentationCode(UserModel user, CxSegmentModel segment, BaseSiteModel baseSite)	Deprecated, for removal: This API element is subject to removal in a future version. since 1811, Use getCustomerSegmentationCode(CxUserToSegmentModel) instead
java.lang.String	getCustomerSegmentationCode(CxUserToSegmentModel userSegment)	Generate customer segmentation code
java.lang.String	getSegmentationCode(java.lang.String... parameters)	Generate customer segmentation code
java.lang.String	getSegmentationCode(java.lang.String segmentId, java.lang.String relatedObjectId, java.lang.String baseSite)	Deprecated, for removal: This API element is subject to removal in a future version. since 1811, use getSegmentationCode(String...) instead
java.lang.String[]	splitCustomerSegmentationCode(java.lang.String segmentationId)
java.lang.String	validateSegmentationCode(java.lang.String code)	Method validates segmentation code and returns error message if code is incorrect.

Field Detail

SEGMENT_INDEX

static final int SEGMENT_INDEX

See Also:

Constant Field Values

CUSTOMER_INDEX

static final int CUSTOMER_INDEX

See Also:

Constant Field Values

BASESITE_INDEX

static final int BASESITE_INDEX

See Also:

Constant Field Values

PROVIDER_INDEX

static final int PROVIDER_INDEX

See Also:

Constant Field Values

NUMBER_OF_CODE_INDEXES

static final int NUMBER_OF_CODE_INDEXES

See Also:

Constant Field Values

Method Detail

getCustomerSegmentationCode

@Deprecated(since="1811",
            forRemoval=true)
java.lang.String getCustomerSegmentationCode(UserModel user,
                                             CxSegmentModel segment,
                                             BaseSiteModel baseSite)

Deprecated, for removal: This API element is subject to removal in a future version.

since 1811, Use getCustomerSegmentationCode(CxUserToSegmentModel) instead

Create customer segmentation code

Parameters:

user - User model

segment - Semment model

baseSite - Basesite for which relation belong

Returns:

customer segmentation code

getCustomerSegmentationCode

java.lang.String getCustomerSegmentationCode(CxUserToSegmentModel userSegment)

Generate customer segmentation code

Parameters:

userSegment - relation beetween customer and segment

Returns:

customer segmentation code

getSegmentationCode

@Deprecated(since="1811",
            forRemoval=true)
java.lang.String getSegmentationCode(java.lang.String segmentId,
                                     java.lang.String relatedObjectId,
                                     java.lang.String baseSite)

Deprecated, for removal: This API element is subject to removal in a future version.

since 1811, use getSegmentationCode(String...) instead

getSegmentationCode

java.lang.String getSegmentationCode(java.lang.String... parameters)

Generate customer segmentation code

Parameters:

parameters - parameters needed to create segmentation code like : user identifier, segment code, basesite identifier, provider identifier. Indexes used to read parameters : CUSTOMER_INDEX,SEGMENT_INDEX, BASESITE_INDEX, PROVIDER_INDEX

Returns:

customer segmentation code

splitCustomerSegmentationCode

java.lang.String[] splitCustomerSegmentationCode(java.lang.String segmentationId)

validateSegmentationCode

java.lang.String validateSegmentationCode(java.lang.String code)

Method validates segmentation code and returns error message if code is incorrect.

Parameters:

code - Segmentation code

Returns:

error message