Package de.hybris.platform.personalizationwebservices.controllers

Class VariationController

java.lang.Object

de.hybris.platform.webservicescommons.controllers.AbstractController

de.hybris.platform.personalizationwebservices.controllers.PersonalizationAbstractController

de.hybris.platform.personalizationwebservices.controllers.VariationController

@RestController
public class VariationController
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	VARIATION
static java.lang.String	VARIATIONS

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
VariationController(VariationFacade cxVariationFacade, org.springframework.validation.Validator variationValidator)

Method Summary

Modifier and Type	Method	Description
org.springframework.http.ResponseEntity<VariationData>	createVariation(java.lang.String catalog, java.lang.String catalogVersion, java.lang.String customizationCode, VariationData variation, org.springframework.web.util.UriComponentsBuilder builder)	Creates variation in given customization
protected VariationListWsDTO	createVariationListWsDTO(java.util.List<VariationData> variations)
void	deleteVariation(java.lang.String catalog, java.lang.String catalogVersion, java.lang.String customizationCode, java.lang.String variationCode)	Removes variation with given code
VariationData	getVariation(java.lang.String catalog, java.lang.String catalogVersion, java.lang.String customizationCode, java.lang.String variationCode)	Retrieves variation with given code from given customization
VariationListWsDTO	getVariations(java.lang.String catalog, java.lang.String catalogVersion, java.lang.String customizationCode)	Returns all variations for given customization code
VariationData	updateVariation(java.lang.String catalog, java.lang.String catalogVersion, java.lang.String customizationCode, java.lang.String variationCode, VariationData variation)	Updates variation with given code in customization with given code
protected void	validateVariation(VariationData variation)

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

VARIATIONS

public static final java.lang.String VARIATIONS

See Also:

Constant Field Values

VARIATION

public static final java.lang.String VARIATION

See Also:

Constant Field Values

Constructor Detail

VariationController

@Autowired
public VariationController(VariationFacade cxVariationFacade,
                           org.springframework.validation.Validator variationValidator)

Method Detail

getVariations

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

createVariation

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

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

@RequestMapping(value="/v1/catalogs/{catalog}/catalogVersions/{catalogVersion}/customizations/{customizationCode}/variations/{variationCode}",
                method=DELETE)
@ResponseStatus(NO_CONTENT)
public void deleteVariation(@PathVariable
                            java.lang.String catalog,
                            @PathVariable
                            java.lang.String catalogVersion,
                            @PathVariable
                            java.lang.String customizationCode,
                            @PathVariable
                            java.lang.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

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

validateVariation

protected void validateVariation(VariationData variation)