Package 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

@RestController
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	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	Description
CustomizationController(CustomizationFacade cxCustomizationFacade, org.springframework.validation.Validator customizationValidator)

Method Summary

Modifier and Type	Method	Description
org.springframework.http.ResponseEntity<CustomizationData>	createCustomization(java.lang.String catalog, java.lang.String catalogVersion, CustomizationData customization, org.springframework.web.util.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

@Autowired
public CustomizationController(CustomizationFacade cxCustomizationFacade,
                               org.springframework.validation.Validator customizationValidator)

Method Detail

getCustomizations

@RequestMapping(value="/v1/catalogs/{catalog}/catalogVersions/{catalogVersion}/customizations",
                method=GET)
public CustomizationListWsDTO getCustomizations(@PathVariable
                                                java.lang.String catalog,
                                                @PathVariable
                                                java.lang.String catalogVersion,
                                                @RequestParam(required=false)
                                                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

@RequestMapping(value="/v1/catalogs/{catalog}/catalogVersions/{catalogVersion}/customizations",
                method=POST)
@ResponseStatus(CREATED)
public org.springframework.http.ResponseEntity<CustomizationData> createCustomization(@PathVariable
                                                                                      java.lang.String catalog,
                                                                                      @PathVariable
                                                                                      java.lang.String catalogVersion,
                                                                                      @RequestBody
                                                                                      CustomizationData customization,
                                                                                      org.springframework.web.util.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

@RequestMapping(value="/v1/catalogs/{catalog}/catalogVersions/{catalogVersion}/customizations/{customizationCode}",
                method=PUT)
public CustomizationData updateCustomization(@PathVariable
                                             java.lang.String catalog,
                                             @PathVariable
                                             java.lang.String catalogVersion,
                                             @PathVariable
                                             java.lang.String customizationCode,
                                             @RequestBody
                                             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

@RequestMapping(value="/v1/catalogs/{catalog}/catalogVersions/{catalogVersion}/customizations/{customizationCode}",
                method=DELETE)
@ResponseStatus(NO_CONTENT)
public void deleteCustomization(@PathVariable
                                java.lang.String catalog,
                                @PathVariable
                                java.lang.String catalogVersion,
                                @PathVariable
                                java.lang.String customizationCode)

Removes customization with given code

Throws:

NotFoundException - if customization with given code does not exists

getCustomization

@RequestMapping(value="/v1/catalogs/{catalog}/catalogVersions/{catalogVersion}/customizations/{customizationCode}",
                method=GET)
public CustomizationData getCustomization(@PathVariable
                                          java.lang.String catalog,
                                          @PathVariable
                                          java.lang.String catalogVersion,
                                          @PathVariable
                                          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)