de.hybris.platform.personalizationservices.service

Interface CxService

All Known Implementing Classes:

DefaultCxService

public interface CxService

Service for general operations on customer experience

Method Summary

Modifier and Type	Method and Description
void	calculateAndLoadPersonalizationInSession(UserModel user, CatalogVersionModel catalogVersion) Calculate personalization for user and catalog version and load it in the session.
void	calculateAndLoadPersonalizationInSession(UserModel cxContextUser, CatalogVersionModel activeCatalogVersion, Collection<CxVariationModel> variations) Calculate personalization for user, catalog version and variation and load it in the session.
void	calculateAndStorePersonalization(UserModel user, CatalogVersionModel catalogVersion) Calculates customization variations for user and store them on the same user.
void	calculatePersonalizationForUser(UserModel user, CatalogVersionModel catalogVersion) Deprecated. Use calculateAndStorePersonalization(UserModel, CatalogVersionModel) and loadPersonalizationInSession(UserModel, Collection)
void	calculatePersonalizationForUser(UserModel user, CatalogVersionModel catalogVersion, Collection<CxVariationModel> variations) Deprecated. Use calculateAndLoadPersonalizationInSession(UserModel, CatalogVersionModel, Collection) instead
void	clearPersonalizationForUser(UserModel user, CatalogVersionModel catalogVersion) Deprecated. Use clearPersonalizationInSession(UserModel, CatalogVersionModel) instead
void	clearPersonalizationInSession(UserModel user, CatalogVersionModel catalogVersion) Removes calculated personalization for user and catalog version from the session.
List<CxAbstractActionResult>	getActionResultsFromSession(UserModel user, CatalogVersionModel catalogVersion) Returned action results stored in session for the user and catalog version.
void	loadPersonalizationInSession(UserModel user, Collection<CatalogVersionModel> catalogVersions) Load calculated personalization for user and catalog version from the database to the session.
CxPersonalizationProcessModel	startPersonalizationCalculationProcess(UserModel user, Collection<CatalogVersionModel> catalogVersions) Update the customer experience through the process engine (asynchronous).

Method Detail

calculatePersonalizationForUser

@Deprecated
void calculatePersonalizationForUser(UserModel user,
                                                 CatalogVersionModel catalogVersion)

Deprecated. Use calculateAndStorePersonalization(UserModel, CatalogVersionModel) and loadPersonalizationInSession(UserModel, Collection)

Calculates personalization for user in given catalog version.

Parameters:

user - user

catalogVersion - catalogVersion

startPersonalizationCalculationProcess

CxPersonalizationProcessModel startPersonalizationCalculationProcess(UserModel user,
                                                                     Collection<CatalogVersionModel> catalogVersions)

Update the customer experience through the process engine (asynchronous).

Parameters:

user -

catalogVersions -

Returns:

running process

calculatePersonalizationForUser

@Deprecated
void calculatePersonalizationForUser(UserModel user,
                                                 CatalogVersionModel catalogVersion,
                                                 Collection<CxVariationModel> variations)

Deprecated. Use calculateAndLoadPersonalizationInSession(UserModel, CatalogVersionModel, Collection) instead

Calculates personalization using given variations in given catalog version.

Parameters:

user - user

catalogVersion - target catalogVersion

variations - variations for calculation

calculateAndStorePersonalization

void calculateAndStorePersonalization(UserModel user,
                                      CatalogVersionModel catalogVersion)

Calculates customization variations for user and store them on the same user.

Parameters:

user - User for which customization variations should be calculated

catalogVersion - Catalog version to which variations are related

clearPersonalizationForUser

@Deprecated
void clearPersonalizationForUser(UserModel user,
                                             CatalogVersionModel catalogVersion)

Deprecated. Use clearPersonalizationInSession(UserModel, CatalogVersionModel) instead

Clears personalization in session for given user in given catalogVersion

Parameters:

user - target user

catalogVersion - target catalogVersion

clearPersonalizationInSession

void clearPersonalizationInSession(UserModel user,
                                   CatalogVersionModel catalogVersion)

Removes calculated personalization for user and catalog version from the session.

Parameters:

user - User for which customization variations should be removed

catalogVersion - Catalog version to which variation are related

loadPersonalizationInSession

void loadPersonalizationInSession(UserModel user,
                                  Collection<CatalogVersionModel> catalogVersions)

Load calculated personalization for user and catalog version from the database to the session.

Parameters:

user -

catalogVersions -

calculateAndLoadPersonalizationInSession

void calculateAndLoadPersonalizationInSession(UserModel cxContextUser,
                                              CatalogVersionModel activeCatalogVersion,
                                              Collection<CxVariationModel> variations)

Calculate personalization for user, catalog version and variation and load it in the session.

Parameters:

cxContextUser -

activeCatalogVersion -

variations -

getActionResultsFromSession

List<CxAbstractActionResult> getActionResultsFromSession(UserModel user,
                                                         CatalogVersionModel catalogVersion)

Returned action results stored in session for the user and catalog version.

Parameters:

user -

catalogVersion -

Returns:

actions results

calculateAndLoadPersonalizationInSession

void calculateAndLoadPersonalizationInSession(UserModel user,
                                              CatalogVersionModel catalogVersion)

Calculate personalization for user and catalog version and load it in the session.

Parameters:

user -

catalogVersion -