de.hybris.platform.personalizationservices.action

Interface CxActionService

All Known Implementing Classes:

DefaultCxActionService

public interface CxActionService

Service for basic operations on actions.

Method Summary

Modifier and Type	Method and Description
CxAbstractActionModel	createAction(CxAbstractActionModel action, CxVariationModel variation) Set default values and creates action for variation.
void	deleteAction(CxAbstractActionModel action) Removes action
java.util.Optional<CxAbstractActionModel>	getAction(java.lang.String code, CxVariationModel variation) Retrieves action with given code from variation.
<T extends CxAbstractActionModel> SearchPageData<T>	getActions(CxActionType type, CatalogVersionModel catalogVersion, java.util.Map<java.lang.String,java.lang.String> searchCriteria, SearchPageData<?> pagination) Retrieve actions of given type that fulfills search criteria in paginated list.
java.util.List<CxAbstractActionModel>	getActions(CxVariationModel variation) Retrieves all actions from given variation.
java.util.List<CxAbstractActionModel>	getActionsForVariations(java.util.Collection<CxVariationModel> variations) Retrieves actions from variations.

Method Detail

getAction

java.util.Optional<CxAbstractActionModel> getAction(java.lang.String code,
                                                    CxVariationModel variation)

Retrieves action with given code from variation. Optional.empty if action with given code does not exists.

Parameters:

code - identifier of action

variation - Variation containing action

Returns:

Action with given code or Optional.empty

getActions

java.util.List<CxAbstractActionModel> getActions(CxVariationModel variation)

Retrieves all actions from given variation.

Parameters:

variation - Variation containing action

Returns:

All actions from variation. Empty list if non were found.

getActions

<T extends CxAbstractActionModel> SearchPageData<T> getActions(CxActionType type,
                                                               CatalogVersionModel catalogVersion,
                                                               java.util.Map<java.lang.String,java.lang.String> searchCriteria,
                                                               SearchPageData<?> pagination)

Retrieve actions of given type that fulfills search criteria in paginated list.

Parameters:

type - Type of action to retrieve. It defines usable search criteria.

catalogVersion - CatalogVersion of searched action

searchCriteria - filters for what actions will be returned.

pagination - pagination data

Returns:

paginated list of actions

Since:

6.7

getActionsForVariations

java.util.List<CxAbstractActionModel> getActionsForVariations(java.util.Collection<CxVariationModel> variations)

Retrieves actions from variations.

Parameters:

variations - from which actions should be retrieved

Returns:

list of actions

createAction

CxAbstractActionModel createAction(CxAbstractActionModel action,
                                   CxVariationModel variation)

Set default values and creates action for variation.

Parameters:

action - Action to create

variation - Variation for which action is created

Returns:

created action

deleteAction

void deleteAction(CxAbstractActionModel action)

Removes action

Parameters:

action - to remove