de.hybris.platform.personalizationfacades.action

Interface ActionFacade

All Known Implementing Classes:

DefaultActionFacade

public interface ActionFacade

Facade for operations on actions.

Method Summary

Modifier and Type	Method and Description
ActionData	createAction(java.lang.String customizationCode, java.lang.String variationCode, ActionData action, java.lang.String catalogId, java.lang.String catalogVersionId) Creates new action in given variation.
default java.util.Collection<ActionData>	createActions(java.lang.String customizationCode, java.lang.String variationCode, java.util.Collection<ActionData> actions, java.lang.String catalogId, java.lang.String catalogVersionId) Creates new actions in given variation.
void	deleteAction(java.lang.String customizationCode, java.lang.String variationCode, java.lang.String actionCode, java.lang.String catalogId, java.lang.String catalogVersionId) Delete action
default void	deleteActions(java.lang.String customizationCode, java.lang.String variationCode, java.util.Collection<java.lang.String> actionCodes, java.lang.String catalogId, java.lang.String catalogVersionId) Delete actions
ActionData	getAction(java.lang.String customizationCode, java.lang.String variationCode, java.lang.String actionCode, java.lang.String catalogId, java.lang.String catalogVersionId) Retrieves action with given code and validates its hierarchy (customization and variation)
SearchPageData<ActionFullData>	getActions(CxActionType type, java.lang.String catalogId, java.lang.String catalogVersionId, 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<ActionData>	getActions(java.lang.String customizationCode, java.lang.String variationCode, java.lang.String catalogId, java.lang.String catalogVersionId) Retrieves all actions in given variation and validates its hierarchy
ActionData	updateAction(java.lang.String customizationCode, java.lang.String variationCode, java.lang.String actionCode, ActionData action, java.lang.String catalogId, java.lang.String catalogVersionId) Updates existing action.

Method Detail

getAction

ActionData getAction(java.lang.String customizationCode,
                     java.lang.String variationCode,
                     java.lang.String actionCode,
                     java.lang.String catalogId,
                     java.lang.String catalogVersionId)

Retrieves action with given code and validates its hierarchy (customization and variation)

Parameters:

customizationCode - Code of parent customization

variationCode - Code of parent variation

actionCode - Code of requested action

catalogId - Catalog identifier

catalogVersionId - Catalog version identifier

Returns:

action with given code

Throws:

UnknownIdentifierException - if action can't be found

getActions

java.util.List<ActionData> getActions(java.lang.String customizationCode,
                                      java.lang.String variationCode,
                                      java.lang.String catalogId,
                                      java.lang.String catalogVersionId)

Retrieves all actions in given variation and validates its hierarchy

Parameters:

customizationCode - Code of parent customization

variationCode - Code of parent variation

catalogId - Catalog identifier

catalogVersionId - Catalog version identifier

Returns:

all actions in given variation

Throws:

UnknownIdentifierException - if customization / variation / catalog does not exist

getActions

SearchPageData<ActionFullData> getActions(CxActionType type,
                                          java.lang.String catalogId,
                                          java.lang.String catalogVersionId,
                                          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.

catalogId - Catalog identifier

catalogVersionId - Catalog version identifier

searchCriteria - filters for what actions will be returned.

pagination - pagination data

Returns:

paginated list of actions

Since:

6.7

createAction

ActionData createAction(java.lang.String customizationCode,
                        java.lang.String variationCode,
                        ActionData action,
                        java.lang.String catalogId,
                        java.lang.String catalogVersionId)

Creates new action in given variation. Throws AlreadyExistsException if action with given code already exists in the system.

Parameters:

customizationCode - Code of parent customization

variationCode - Code of parent variation

action - Action representation to create

catalogId - Catalog identifier

catalogVersionId - Catalog version identifier

Returns:

created object

Throws:

UnknownIdentifierException - if customization / variation / catalog does not exist

AlreadyExistsException - if action already exists

createActions

default java.util.Collection<ActionData> createActions(java.lang.String customizationCode,
                                                       java.lang.String variationCode,
                                                       java.util.Collection<ActionData> actions,
                                                       java.lang.String catalogId,
                                                       java.lang.String catalogVersionId)

Creates new actions in given variation. Throws AlreadyExistsException if action with given code already exists in the system.

Parameters:

customizationCode - Code of parent customization

variationCode - Code of parent variation

actions - Actions representation to create

catalogId - Catalog identifier

catalogVersionId - Catalog version identifier

Returns:

created objects

Throws:

UnknownIdentifierException - if customization / variation / catalog does not exist

AlreadyExistsException - if at least one of the actions already exists

updateAction

ActionData updateAction(java.lang.String customizationCode,
                        java.lang.String variationCode,
                        java.lang.String actionCode,
                        ActionData action,
                        java.lang.String catalogId,
                        java.lang.String catalogVersionId)

Updates existing action. actionCode takes precedence over code property of action objects

Parameters:

customizationCode - Code of parent customization

variationCode - Code of parent variation

actionCode - Code of action to update

action - Action data for update

catalogId - Catalog identifier

catalogVersionId - Catalog version identifier

Returns:

Updated action

Throws:

UnknownIdentifierException - if customization / variation / action / catalog does not exist

deleteAction

void deleteAction(java.lang.String customizationCode,
                  java.lang.String variationCode,
                  java.lang.String actionCode,
                  java.lang.String catalogId,
                  java.lang.String catalogVersionId)

Delete action

Parameters:

customizationCode - Code of parent customization

variationCode - Code of parent variation

actionCode - Code of the action to delete

catalogId - Catalog identifier

catalogVersionId - Catalog version identifier

Throws:

UnknownIdentifierException - if customization / variation / action / catalog does not exist

deleteActions

default void deleteActions(java.lang.String customizationCode,
                           java.lang.String variationCode,
                           java.util.Collection<java.lang.String> actionCodes,
                           java.lang.String catalogId,
                           java.lang.String catalogVersionId)

Delete actions

Parameters:

customizationCode - Code of parent customization

variationCode - Code of parent variation

actionCodes - Codes of actions to delete

catalogId - Catalog identifier

catalogVersionId - Catalog version identifier

Throws:

UnknownIdentifierException - if customization / variation / action / catalog does not exist