de.hybris.platform.personalizationwebservices.controllers

Class CustomizationController

java.lang.Object

de.hybris.platform.webservicescommons.controllers.AbstractController

de.hybris.platform.personalizationwebservices.controllers.PersonalizationAbstractController

de.hybris.platform.personalizationwebservices.controllers.CustomizationController

public class CustomizationController
extends PersonalizationAbstractController

Controller exposes functionality for customizations, variations and actions

Nested Class Summary

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

AbstractController.Executor

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CUSTOMIZATION
static java.lang.String	CUSTOMIZATIONS

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

BASE_URL, VERSION

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

CATALOG_PATH

Constructor Summary

Constructors

Constructor and Description
CustomizationController(CustomizationFacade customizationFacade, Validator customizationValidator)

Method Summary

Modifier and Type	Method and Description
<any>	createCustomization(java.lang.String catalog, java.lang.String catalogVersion, CustomizationData customization, UriComponentsBuilder builder) Creates customization
protected CustomizationListWsDTO	createListDTO(SearchPageData<CustomizationData> customizations)
void	deleteCustomization(java.lang.String catalog, java.lang.String catalogVersion, java.lang.String customizationCode) Removes customization with given code
CustomizationData	getCustomization(java.lang.String catalog, java.lang.String catalogVersion, java.lang.String customizationCode) Returns customization with given code
CustomizationListWsDTO	getCustomizations(java.lang.String catalog, java.lang.String catalogVersion, java.util.Map<java.lang.String,java.lang.String> requestParams) Returns all customizations
CustomizationData	updateCustomization(java.lang.String catalog, java.lang.String catalogVersion, java.lang.String customizationCode, CustomizationData customization) Updates customization with given code
protected void	validateCustomization(CustomizationData customization)

Methods inherited from class de.hybris.platform.webservicescommons.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 java.lang.String CUSTOMIZATIONS

See Also:

Constant Field Values

CUSTOMIZATION

public static final java.lang.String CUSTOMIZATION

See Also:

Constant Field Values

Constructor Detail

CustomizationController

public CustomizationController(CustomizationFacade customizationFacade,
                               Validator customizationValidator)

Method Detail

getCustomizations

public CustomizationListWsDTO getCustomizations(java.lang.String catalog,
                                                java.lang.String catalogVersion,
                                                java.util.Map<java.lang.String,java.lang.String> requestParams)

Returns all customizations

Returns:

Collection of all customizations

createListDTO

protected CustomizationListWsDTO createListDTO(SearchPageData<CustomizationData> customizations)

createCustomization

public <any> createCustomization(java.lang.String catalog,
                                 java.lang.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(java.lang.String catalog,
                                             java.lang.String catalogVersion,
                                             java.lang.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(java.lang.String catalog,
                                java.lang.String catalogVersion,
                                java.lang.String customizationCode)

Removes customization with given code

Throws:

NotFoundException - if customization with given code does not exists

getCustomization

public CustomizationData getCustomization(java.lang.String catalog,
                                          java.lang.String catalogVersion,
                                          java.lang.String customizationCode)

Returns customization with given code

Returns:

customization with given code

Throws:

NotFoundException - if customization with given code does not exists

validateCustomization

protected void validateCustomization(CustomizationData customization)