Class ActionController
java.lang.Object
de.hybris.platform.webservicescommons.controllers.AbstractController
de.hybris.platform.personalizationwebservices.controllers.PersonalizationAbstractController
de.hybris.platform.personalizationwebservices.controllers.ActionController
Controller exposes functionality for 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
ConstructorsConstructorDescriptionActionController(ActionFacade cxActionFacade, org.springframework.validation.Validator actionValidator, org.springframework.validation.Validator actionsValidator) -
Method Summary
Modifier and TypeMethodDescriptionorg.springframework.http.ResponseEntity<ActionData>createAction(String catalog, String catalogVersion, String customizationCode, String variationCode, ActionData action, org.springframework.web.util.UriComponentsBuilder builder) Creates action in given variationprotected ActionListWsDTOcreateActionListWsDTO(Collection<ActionData> actions) createActions(String catalog, String catalogVersion, String customizationCode, String variationCode, ActionListWsDTO actionList) Creates set of actions in given variationvoiddeleteAction(String catalog, String catalogVersion, String customizationCode, String variationCode, String actionCode) Deletes action with given codevoiddeleteActions(String catalog, String catalogVersion, String customizationCode, String variationCode, String[] actionCodes) Deletes actions with given codesgetAction(String catalog, String catalogVersion, CxActionType type, Map<String, String> searchCriteria) Retrieves actions with given parametersgetAction(String catalog, String catalogVersion, String customizationCode, String variationCode, String actionCode) Retrieves action with given codegetActions(String catalog, String catalogVersion, String customizationCode, String variationCode) Retrieves all actions in given variationupdateAction(String catalog, String catalogVersion, String customizationCode, String variationCode, String actionCode, ActionData action) Updates action with given codeprotected voidvalidateAction(ActionData action) protected voidvalidateActions(ActionListWsDTO action) Methods inherited from class de.hybris.platform.webservicescommons.controllers.AbstractController
executeAndConvertException, executeAndConvertException, getBindingResult, getLocationHeader, getWebPaginationUtils, setWebPaginationUtils, validate, validate, validateInputCode, validateResponse
-
Field Details
-
ACTIONS
- See Also:
-
ACTION
- See Also:
-
FULL_ACTIONS
- See Also:
-
-
Constructor Details
-
ActionController
@Autowired public ActionController(ActionFacade cxActionFacade, org.springframework.validation.Validator actionValidator, org.springframework.validation.Validator actionsValidator)
-
-
Method Details
-
getActions
@RequestMapping(value="/v1/catalogs/{catalog}/catalogVersions/{catalogVersion}/customizations/{customizationCode}/variations/{variationCode}/actions", method=GET) public ActionListWsDTO getActions(@PathVariable String catalog, @PathVariable String catalogVersion, @PathVariable String customizationCode, @PathVariable 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
-
createAction
@RequestMapping(value="/v1/catalogs/{catalog}/catalogVersions/{catalogVersion}/customizations/{customizationCode}/variations/{variationCode}/actions", method=POST, consumes={"application/json","application/xml"}) @ResponseStatus(CREATED) public org.springframework.http.ResponseEntity<ActionData> createAction(@PathVariable String catalog, @PathVariable String catalogVersion, @PathVariable String customizationCode, @PathVariable String variationCode, @RequestBody ActionData action, org.springframework.web.util.UriComponentsBuilder builder) Creates action in given variation- Returns:
- created action
- Throws:
AlreadyExistsException- if variation with given code already existsWebserviceValidationException- 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
-
createActions
@ResponseStatus(CREATED) @RequestMapping(value="/v1/catalogs/{catalog}/catalogVersions/{catalogVersion}/customizations/{customizationCode}/variations/{variationCode}/actions", method=PATCH, consumes={"application/json","application/xml"}) public ActionListWsDTO createActions(@PathVariable String catalog, @PathVariable String catalogVersion, @PathVariable String customizationCode, @PathVariable String variationCode, @RequestBody ActionListWsDTO actionList) Creates set of actions in given variation- Returns:
- actionListWsDTO with created actions
-
deleteActions
@RequestMapping(value="/v1/catalogs/{catalog}/catalogVersions/{catalogVersion}/customizations/{customizationCode}/variations/{variationCode}/actions", method=DELETE, consumes={"application/json","application/xml"}) @ResponseStatus(NO_CONTENT) public void deleteActions(@PathVariable String catalog, @PathVariable String catalogVersion, @PathVariable String customizationCode, @PathVariable String variationCode, @RequestBody 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
@RequestMapping(value="/v1/catalogs/{catalog}/catalogVersions/{catalogVersion}/customizations/{customizationCode}/variations/{variationCode}/actions/{actionCode}", method=PUT, consumes={"application/json","application/xml"}) public ActionData updateAction(@PathVariable String catalog, @PathVariable String catalogVersion, @PathVariable String customizationCode, @PathVariable String variationCode, @PathVariable String actionCode, @RequestBody ActionData action) Updates action with given code- Returns:
- updated action
- Throws:
WebserviceValidationException- if provided data is invalidNotFoundException- 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
@RequestMapping(value="/v1/catalogs/{catalog}/catalogVersions/{catalogVersion}/customizations/{customizationCode}/variations/{variationCode}/actions/{actionCode}", method=DELETE) @ResponseStatus(NO_CONTENT) public void deleteAction(@PathVariable String catalog, @PathVariable String catalogVersion, @PathVariable String customizationCode, @PathVariable String variationCode, @PathVariable 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
@RequestMapping(value="/v1/catalogs/{catalog}/catalogVersions/{catalogVersion}/customizations/{customizationCode}/variations/{variationCode}/actions/{actionCode}", method=GET) public ActionData getAction(@PathVariable String catalog, @PathVariable String catalogVersion, @PathVariable String customizationCode, @PathVariable String variationCode, @PathVariable 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
-
getAction
@RequestMapping(value="/v1/catalogs/{catalog}/catalogVersions/{catalogVersion}/actions", method=GET) public ActionFullListWsDTO getAction(@PathVariable String catalog, @PathVariable String catalogVersion, @RequestParam CxActionType type, @RequestParam Map<String, String> searchCriteria) Retrieves actions with given parameters- 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
-
validateAction
-
validateActions
-