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) Calculate personalization for user, all configured catalog versions and loads it in the session.
void	calculateAndLoadPersonalizationInSession(UserModel user, CatalogVersionModel catalogVersion) Calculate personalization for user and catalog version and load it in the session.
void	calculateAndLoadPersonalizationInSession(UserModel user, CatalogVersionModel catalogVersion, java.util.Collection<CxVariationModel> variations) Calculate personalization for user, catalog version and variation and load it in the session.
void	calculateAndStoreDefaultPersonalization(java.util.Collection<CatalogVersionModel> catalogVersions) Calculates default personalization results and stores it.
void	calculateAndStorePersonalization(UserModel user) Calculates personalization for user and stores it.
void	calculateAndStorePersonalization(UserModel user, CatalogVersionModel catalogVersion) Calculates personalization for user and stores it.
void	clearPersonalizationInSession(UserModel user, CatalogVersionModel catalogVersion) Removes calculated personalization for user and catalog version from the session.
java.util.List<CxAbstractActionResult>	getActionResultsFromSession(UserModel user) Returned action results stored in session for the user and all configured catalog version.
java.util.List<CxAbstractActionResult>	getActionResultsFromSession(UserModel user, CatalogVersionModel catalogVersion) Returned action results stored in session for the user and catalog version.
void	loadPersonalizationInSession(UserModel user) Load calculated personalization for user and all configured catalog version from the database to the session.
void	loadPersonalizationInSession(UserModel user, java.util.Collection<CatalogVersionModel> catalogVersions) Load calculated personalization for user and catalog version from the database to the session.
java.util.List<CxPersonalizationProcessModel>	startPersonalizationCalculationProcesses(UserModel user) Update the customer experience through the process engine (asynchronous).
java.util.List<CxPersonalizationProcessModel>	startPersonalizationCalculationProcesses(UserModel user, java.util.Collection<CatalogVersionModel> catalogVersions) Update the customer experience through the process engine (asynchronous).
java.util.List<CxPersonalizationProcessModel>	startPersonalizationCalculationProcesses(UserModel user, CxCalculationContext context) Update the customer experience through the process engine (asynchronous).

Method Detail

startPersonalizationCalculationProcesses

java.util.List<CxPersonalizationProcessModel> startPersonalizationCalculationProcesses(UserModel user)

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

Parameters:

user - for which personalization should be calculated

Returns:

running processes

Since:

6.6

startPersonalizationCalculationProcesses

java.util.List<CxPersonalizationProcessModel> startPersonalizationCalculationProcesses(UserModel user,
                                                                                       java.util.Collection<CatalogVersionModel> catalogVersions)

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

Parameters:

user - for which personalization should be calculated

catalogVersions - collection of catalog versions for which personalization should be calculated

Returns:

running processes

Since:

6.4

startPersonalizationCalculationProcesses

java.util.List<CxPersonalizationProcessModel> startPersonalizationCalculationProcesses(UserModel user,
                                                                                       CxCalculationContext context)

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

Parameters:

user - for which personalization should be calculated

context - Context with additional parameters

Returns:

running processes

Since:

1811

calculateAndStoreDefaultPersonalization

void calculateAndStoreDefaultPersonalization(java.util.Collection<CatalogVersionModel> catalogVersions)

Calculates default personalization results and stores it.

Parameters:

catalogVersions - for which default personalization will be calculated and stored

Since:

1811

calculateAndStorePersonalization

void calculateAndStorePersonalization(UserModel user)

Calculates personalization for user and stores it.

Parameters:

user - User for which customization variations should be calculated

Since:

6.6

calculateAndStorePersonalization

void calculateAndStorePersonalization(UserModel user,
                                      CatalogVersionModel catalogVersion)

Calculates personalization for user and stores it.

Parameters:

user - User for which customization variations should be calculated

catalogVersion - Catalog version to which variations are related

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)

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

Parameters:

user - for which personalization will be loaded

Since:

6.6

loadPersonalizationInSession

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

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

Parameters:

user - for which personalization will be loaded

catalogVersions - for which personalization will be loaded

getActionResultsFromSession

java.util.List<CxAbstractActionResult> getActionResultsFromSession(UserModel user)

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

Parameters:

user - for which action results will be returned

Returns:

list of action results for given user

Since:

6.6

getActionResultsFromSession

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

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

Parameters:

user - for which personalization will be returned

catalogVersion - for which personalization will be returned

Returns:

list of actions results stored

calculateAndLoadPersonalizationInSession

void calculateAndLoadPersonalizationInSession(UserModel user)

Calculate personalization for user, all configured catalog versions and loads it in the session.

Parameters:

user - for which personalization will be calculated and loaded

Since:

6.6

calculateAndLoadPersonalizationInSession

void calculateAndLoadPersonalizationInSession(UserModel user,
                                              CatalogVersionModel catalogVersion)

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

Parameters:

user - for which personalization will be calculated and loaded

catalogVersion - for which personalization will be calculated and loaded

calculateAndLoadPersonalizationInSession

void calculateAndLoadPersonalizationInSession(UserModel user,
                                              CatalogVersionModel catalogVersion,
                                              java.util.Collection<CxVariationModel> variations)

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

Parameters:

user - for which personalization will be loaded

catalogVersion - for which personalization will be calculated and loaded

variations - for which personalization will be calculated