Class VariationController
java.lang.Object
de.hybris.platform.webservicescommons.controllers.AbstractController
de.hybris.platform.personalizationwebservices.controllers.PersonalizationAbstractController
de.hybris.platform.personalizationwebservices.controllers.VariationController
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
FieldsFields inherited from class de.hybris.platform.personalizationwebservices.controllers.PersonalizationAbstractController
BASE_URL, VERSIONFields inherited from class de.hybris.platform.webservicescommons.controllers.AbstractController
CATALOG_PATH -
Constructor Summary
ConstructorsConstructorDescriptionVariationController(VariationFacade cxVariationFacade, org.springframework.validation.Validator variationValidator) -
Method Summary
Modifier and TypeMethodDescriptionorg.springframework.http.ResponseEntity<VariationData>createVariation(String catalog, String catalogVersion, String customizationCode, VariationData variation, org.springframework.web.util.UriComponentsBuilder builder) Creates variation in given customizationprotected VariationListWsDTOcreateVariationListWsDTO(List<VariationData> variations) voiddeleteVariation(String catalog, String catalogVersion, String customizationCode, String variationCode) Removes variation with given codegetVariation(String catalog, String catalogVersion, String customizationCode, String variationCode) Retrieves variation with given code from given customizationgetVariations(String catalog, String catalogVersion, String customizationCode) Returns all variations for given customization codeupdateVariation(String catalog, String catalogVersion, String customizationCode, String variationCode, VariationData variation) Updates variation with given code in customization with given codeprotected voidvalidateVariation(VariationData variation) Methods inherited from class de.hybris.platform.webservicescommons.controllers.AbstractController
executeAndConvertException, executeAndConvertException, getBindingResult, getLocationHeader, getWebPaginationUtils, setWebPaginationUtils, validate, validate, validateInputCode, validateResponse
-
Field Details
-
VARIATIONS
- See Also:
-
VARIATION
- See Also:
-
-
Constructor Details
-
VariationController
@Autowired public VariationController(VariationFacade cxVariationFacade, org.springframework.validation.Validator variationValidator)
-
-
Method Details
-
getVariations
@RequestMapping(value="/v1/catalogs/{catalog}/catalogVersions/{catalogVersion}/customizations/{customizationCode}/variations", method=GET) public VariationListWsDTO getVariations(@PathVariable String catalog, @PathVariable String catalogVersion, @PathVariable 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
-
createVariation
@RequestMapping(value="/v1/catalogs/{catalog}/catalogVersions/{catalogVersion}/customizations/{customizationCode}/variations", method=POST, consumes={"application/json","application/xml"}) @ResponseStatus(CREATED) public org.springframework.http.ResponseEntity<VariationData> createVariation(@PathVariable String catalog, @PathVariable String catalogVersion, @PathVariable 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 existsWebserviceValidationException- if provided data is invalidNotFoundException- if catalog version doesn't exists
-
updateVariation
@RequestMapping(value="/v1/catalogs/{catalog}/catalogVersions/{catalogVersion}/customizations/{customizationCode}/variations/{variationCode}", method=PUT, consumes={"application/json","application/xml"}) public VariationData updateVariation(@PathVariable String catalog, @PathVariable String catalogVersion, @PathVariable String customizationCode, @PathVariable String variationCode, @RequestBody VariationData variation) Updates variation with given code in customization with given code- Returns:
- updated variation
- Throws:
WebserviceValidationException- if provided data is invalidNotFoundException- 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 String catalog, @PathVariable String catalogVersion, @PathVariable String customizationCode, @PathVariable 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 String catalog, @PathVariable String catalogVersion, @PathVariable String customizationCode, @PathVariable 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
-