Class ActionController
- java.lang.Object
-
- de.hybris.platform.webservicescommons.controllers.AbstractController
-
- de.hybris.platform.personalizationwebservices.controllers.PersonalizationAbstractController
-
- de.hybris.platform.personalizationwebservices.controllers.ActionController
-
@RestController public class ActionController extends PersonalizationAbstractController
Controller exposes functionality for 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
ACTION
static java.lang.String
ACTIONS
static java.lang.String
FULL_ACTIONS
-
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 ActionController(ActionFacade actionFacade, org.springframework.validation.Validator actionValidator, org.springframework.validation.Validator actionsValidator)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description org.springframework.http.ResponseEntity<ActionData>
createAction(java.lang.String catalog, java.lang.String catalogVersion, java.lang.String customizationCode, java.lang.String variationCode, ActionData action, org.springframework.web.util.UriComponentsBuilder builder)
Creates action in given variationprotected ActionListWsDTO
createActionListWsDTO(java.util.Collection<ActionData> actions)
ActionListWsDTO
createActions(java.lang.String catalog, java.lang.String catalogVersion, java.lang.String customizationCode, java.lang.String variationCode, ActionListWsDTO actionList)
Creates set of actions in given variationvoid
deleteAction(java.lang.String catalog, java.lang.String catalogVersion, java.lang.String customizationCode, java.lang.String variationCode, java.lang.String actionCode)
Deletes action with given codevoid
deleteActions(java.lang.String catalog, java.lang.String catalogVersion, java.lang.String customizationCode, java.lang.String variationCode, java.lang.String[] actionCodes)
Deletes actions with given codesActionFullListWsDTO
getAction(java.lang.String catalog, java.lang.String catalogVersion, CxActionType type, java.util.Map<java.lang.String,java.lang.String> searchCriteria)
Retrieves actions with given parametersActionData
getAction(java.lang.String catalog, java.lang.String catalogVersion, java.lang.String customizationCode, java.lang.String variationCode, java.lang.String actionCode)
Retrieves action with given codeActionListWsDTO
getActions(java.lang.String catalog, java.lang.String catalogVersion, java.lang.String customizationCode, java.lang.String variationCode)
Retrieves all actions in given variationActionData
updateAction(java.lang.String catalog, java.lang.String catalogVersion, java.lang.String customizationCode, java.lang.String variationCode, java.lang.String actionCode, ActionData action)
Updates action with given codeprotected void
validateAction(ActionData action)
protected void
validateActions(ActionListWsDTO action)
-
Methods inherited from class de.hybris.platform.webservicescommons.controllers.AbstractController
executeAndConvertException, executeAndConvertException, getBindingResult, getLocationHeader, getWebPaginationUtils, setWebPaginationUtils, validate, validate, validateInputCode, validateResponse
-
-
-
-
Field Detail
-
ACTIONS
public static final java.lang.String ACTIONS
- See Also:
- Constant Field Values
-
ACTION
public static final java.lang.String ACTION
- See Also:
- Constant Field Values
-
FULL_ACTIONS
public static final java.lang.String FULL_ACTIONS
- See Also:
- Constant Field Values
-
-
Constructor Detail
-
ActionController
@Autowired public ActionController(ActionFacade actionFacade, org.springframework.validation.Validator actionValidator, org.springframework.validation.Validator actionsValidator)
-
-
Method Detail
-
getActions
@RequestMapping(value="/v1/catalogs/{catalog}/catalogVersions/{catalogVersion}/customizations/{customizationCode}/variations/{variationCode}/actions", method=GET) public ActionListWsDTO getActions(@PathVariable java.lang.String catalog, @PathVariable java.lang.String catalogVersion, @PathVariable java.lang.String customizationCode, @PathVariable java.lang.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
protected ActionListWsDTO createActionListWsDTO(java.util.Collection<ActionData> actions)
-
createAction
@RequestMapping(value="/v1/catalogs/{catalog}/catalogVersions/{catalogVersion}/customizations/{customizationCode}/variations/{variationCode}/actions", method=POST) @ResponseStatus(CREATED) public org.springframework.http.ResponseEntity<ActionData> createAction(@PathVariable java.lang.String catalog, @PathVariable java.lang.String catalogVersion, @PathVariable java.lang.String customizationCode, @PathVariable java.lang.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) public ActionListWsDTO createActions(@PathVariable java.lang.String catalog, @PathVariable java.lang.String catalogVersion, @PathVariable java.lang.String customizationCode, @PathVariable java.lang.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) @ResponseStatus(NO_CONTENT) public void deleteActions(@PathVariable java.lang.String catalog, @PathVariable java.lang.String catalogVersion, @PathVariable java.lang.String customizationCode, @PathVariable java.lang.String variationCode, @RequestBody java.lang.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) public ActionData updateAction(@PathVariable java.lang.String catalog, @PathVariable java.lang.String catalogVersion, @PathVariable java.lang.String customizationCode, @PathVariable java.lang.String variationCode, @PathVariable java.lang.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 java.lang.String catalog, @PathVariable java.lang.String catalogVersion, @PathVariable java.lang.String customizationCode, @PathVariable java.lang.String variationCode, @PathVariable java.lang.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 java.lang.String catalog, @PathVariable java.lang.String catalogVersion, @PathVariable java.lang.String customizationCode, @PathVariable java.lang.String variationCode, @PathVariable java.lang.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 java.lang.String catalog, @PathVariable java.lang.String catalogVersion, @RequestParam CxActionType type, @RequestParam java.util.Map<java.lang.String,java.lang.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
protected void validateAction(ActionData action)
-
validateActions
protected void validateActions(ActionListWsDTO action)
-
-