de.hybris.platform.personalizationwebservices.controllers

Class CustomizationController

java.lang.Object

de.hybris.platform.personalizationwebservices.controllers.AbstractController

de.hybris.platform.personalizationwebservices.controllers.CustomizationController

public class CustomizationController
extends AbstractController

Controller exposes functionality for customizations, variations and actions

Nested Class Summary

Nested classes/interfaces inherited from class de.hybris.platform.personalizationwebservices.controllers.AbstractController

AbstractController.Executor

Field Summary

Fields

Modifier and Type	Field and Description
static String	ACTION
static String	ACTIONS
static String	CUSTOMIZATION
static String	CUSTOMIZATIONS
static String	VARIATION
static String	VARIATIONS

Fields inherited from class de.hybris.platform.personalizationwebservices.controllers.AbstractController

BASE_URL, VERSION

Constructor Summary

Constructors

Constructor and Description
CustomizationController(ActionFacade actionFacade, CustomizationFacade customizationFacade, VariationFacade variationFacade, Validator customizationValidator, Validator variationValidator, Validator actionValidator, Validator actionsValidator)

Method Summary

Modifier and Type	Method and Description
<any>	createAction(String catalog, String catalogVersion, String customizationCode, String variationCode, ActionData action, UriComponentsBuilder builder) Creates action in given variation
protected ActionListWsDTO	createActionListWsDTO(Collection<ActionData> actions)
ActionListWsDTO	createActions(String catalog, String catalogVersion, String customizationCode, String variationCode, ActionListWsDTO actionList) Creates set of actions in given variation
<any>	createCustomization(String catalog, String catalogVersion, CustomizationData customization, UriComponentsBuilder builder) Creates customization
protected CustomizationListWsDTO	createListDTO(SearchResult<CustomizationData> customizations)
<any>	createVariation(String catalog, String catalogVersion, String customizationCode, VariationData variation, UriComponentsBuilder builder) Creates variation in given customization
protected VariationListWsDTO	createVariationListWsDTO(List<VariationData> variations)
void	deleteAction(String catalog, String catalogVersion, String customizationCode, String variationCode, String actionCode) Deletes action with given code
void	deleteActions(String catalog, String catalogVersion, String customizationCode, String variationCode, String[] actionCodes) Deletes actions with given codes
void	deleteCustomization(String catalog, String catalogVersion, String customizationCode) Removes customization with given code
void	deleteVariation(String catalog, String catalogVersion, String customizationCode, String variationCode) Removes variation with given code
ActionData	getAction(String catalog, String catalogVersion, String customizationCode, String variationCode, String actionCode) Retrieves action with given code
ActionListWsDTO	getActions(String catalog, String catalogVersion, String customizationCode, String variationCode) Retrieves all actions in given variation
CustomizationData	getCustomization(String catalog, String catalogVersion, String customizationCode) Returns customization with given code
CustomizationListWsDTO	getCustomizations(String catalog, String catalogVersion, Map<String,String> requestParams) Returns all customizations
VariationData	getVariation(String catalog, String catalogVersion, String customizationCode, String variationCode) Retrieves variation with given code from given customization
VariationListWsDTO	getVariations(String catalog, String catalogVersion, String customizationCode) Returns all variations for given customization code
ActionData	updateAction(String catalog, String catalogVersion, String customizationCode, String variationCode, String actionCode, ActionData action) Updates action with given code
CustomizationData	updateCustomization(String catalog, String catalogVersion, String customizationCode, CustomizationData customization) Updates customization with given code
VariationData	updateVariation(String catalog, String catalogVersion, String customizationCode, String variationCode, VariationData variation) Updates variation with given code in customization with given code
protected void	validateAction(ActionData action)
protected void	validateActions(ActionListWsDTO action)
protected void	validateCustomization(CustomizationData customization)
protected void	validateVariation(VariationData variation)

Methods inherited from class de.hybris.platform.personalizationwebservices.controllers.AbstractController

executeAndConvertException, executeAndConvertException, getBindingResult, getLocationHeader, getWebPaginationUtils, setWebPaginationUtils, validate, validate, validateInputCode, validateResponse

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

CUSTOMIZATIONS

public static final String CUSTOMIZATIONS

See Also:

Constant Field Values

CUSTOMIZATION

public static final String CUSTOMIZATION

See Also:

Constant Field Values

VARIATIONS

public static final String VARIATIONS

See Also:

Constant Field Values

VARIATION

public static final String VARIATION

See Also:

Constant Field Values

ACTIONS

public static final String ACTIONS

See Also:

Constant Field Values

ACTION

public static final String ACTION

See Also:

Constant Field Values

Constructor Detail

CustomizationController

public CustomizationController(ActionFacade actionFacade,
                               CustomizationFacade customizationFacade,
                               VariationFacade variationFacade,
                               Validator customizationValidator,
                               Validator variationValidator,
                               Validator actionValidator,
                               Validator actionsValidator)

Method Detail

getCustomizations

public CustomizationListWsDTO getCustomizations(String catalog,
                                                String catalogVersion,
                                                Map<String,String> requestParams)

Returns all customizations

Returns:

Collection of all customizations

createListDTO

protected CustomizationListWsDTO createListDTO(SearchResult<CustomizationData> customizations)

createCustomization

public <any> createCustomization(String catalog,
                                 String catalogVersion,
                                 CustomizationData customization,
                                 UriComponentsBuilder builder)

Creates customization

Returns:

created customization

Throws:

AlreadyExistsException - if customization with given code already exists

WebserviceValidationException - if provided customization data is invalid

NotFoundException - if catalog version doesn't exists

updateCustomization

public CustomizationData updateCustomization(String catalog,
                                             String catalogVersion,
                                             String customizationCode,
                                             CustomizationData customization)

Updates customization with given code

Returns:

updated customization

Throws:

WebserviceValidationException - if provided data is invalid

NotFoundException - if customization with given code does not exists

deleteCustomization

public void deleteCustomization(String catalog,
                                String catalogVersion,
                                String customizationCode)

Removes customization with given code

Throws:

NotFoundException - if customization with given code does not exists

getCustomization

public CustomizationData getCustomization(String catalog,
                                          String catalogVersion,
                                          String customizationCode)

Returns customization with given code

Returns:

customization with given code

Throws:

NotFoundException - if customization with given code does not exists

getVariations

public VariationListWsDTO getVariations(String catalog,
                                        String catalogVersion,
                                        String customizationCode)

Returns all variations for given customization code

Parameters:

customizationCode - customization identifier

Returns:

Collection of all variations in given customziation

Throws:

NotFoundException - if customization with given code does not exists

createVariationListWsDTO

protected VariationListWsDTO createVariationListWsDTO(List<VariationData> variations)

createVariation

public <any> createVariation(String catalog,
                             String catalogVersion,
                             String customizationCode,
                             VariationData variation,
                             UriComponentsBuilder builder)

Creates variation in given customization

Returns:

created variation

Throws:

AlreadyExistsException - if variation with given code already exists

WebserviceValidationException - if provided data is invalid

NotFoundException - if catalog version doesn't exists

updateVariation

public VariationData updateVariation(String catalog,
                                     String catalogVersion,
                                     String customizationCode,
                                     String variationCode,
                                     VariationData variation)

Updates variation with given code in customization with given code

Returns:

updated variation

Throws:

WebserviceValidationException - if provided data is invalid

NotFoundException - if variation with given code does not exists or customization with given code does not exists or variation and customization are not related

deleteVariation

public void deleteVariation(String catalog,
                            String catalogVersion,
                            String customizationCode,
                            String variationCode)

Removes variation with given code

Throws:

NotFoundException - if variation with given code does not exists or customization with given code does not exists or variation and customization are not related

getVariation

public VariationData getVariation(String catalog,
                                  String catalogVersion,
                                  String customizationCode,
                                  String variationCode)

Retrieves variation with given code from given customization

Returns:

variation with given code

Throws:

NotFoundException - if variation with given code does not exists or customization with given code does not exists or variation and customization are not related

getActions

public ActionListWsDTO getActions(String catalog,
                                  String catalogVersion,
                                  String customizationCode,
                                  String variationCode)

Retrieves all actions in given variation

Returns:

collection of actions in given variation

Throws:

NotFoundException - if variation with given code does not exists or customization with given code does not exists or variation and customization are not related

createActionListWsDTO

protected ActionListWsDTO createActionListWsDTO(Collection<ActionData> actions)

createAction

public <any> createAction(String catalog,
                          String catalogVersion,
                          String customizationCode,
                          String variationCode,
                          ActionData action,
                          UriComponentsBuilder builder)

Creates action in given variation

Returns:

created action

Throws:

AlreadyExistsException - if variation with given code already exists

WebserviceValidationException - if provided data is invalid

NotFoundException - if variation with given code does not exists or customization with given code does not exists or variation and customization are not related

createActions

public ActionListWsDTO createActions(String catalog,
                                     String catalogVersion,
                                     String customizationCode,
                                     String variationCode,
                                     ActionListWsDTO actionList)

Creates set of actions in given variation

Returns:

actionListWsDTO with created actions

deleteActions

public void deleteActions(String catalog,
                          String catalogVersion,
                          String customizationCode,
                          String variationCode,
                          String[] actionCodes)

Deletes actions with given codes

Throws:

NotFoundException - if action with given code does not exists or variation with given code does not exists or customization with given code does not exists or action and variation are not related or variation and customization are not related

updateAction

public ActionData updateAction(String catalog,
                               String catalogVersion,
                               String customizationCode,
                               String variationCode,
                               String actionCode,
                               ActionData action)

Updates action with given code

Returns:

updated action

Throws:

WebserviceValidationException - if provided data is invalid

NotFoundException - if action with given code does not exists or variation with given code does not exists or customization with given code does not exists or action and variation are not related or variation and customization are not related

deleteAction

public void deleteAction(String catalog,
                         String catalogVersion,
                         String customizationCode,
                         String variationCode,
                         String actionCode)

Deletes action with given code

Throws:

NotFoundException - if action with given code does not exists or variation with given code does not exists or customization with given code does not exists or action and variation are not related or variation and customization are not related

getAction

public ActionData getAction(String catalog,
                            String catalogVersion,
                            String customizationCode,
                            String variationCode,
                            String actionCode)

Retrieves action with given code

Returns:

Throws:

NotFoundException - if action with given code does not exists or variation with given code does not exists or customization with given code does not exists or action and variation are not related or variation and customization are not related

validateCustomization

protected void validateCustomization(CustomizationData customization)

validateVariation

protected void validateVariation(VariationData variation)

validateAction

protected void validateAction(ActionData action)

validateActions

protected void validateActions(ActionListWsDTO action)