@RestController public class ActionController extends PersonalizationAbstractController
Controller exposes functionality for actions
  • Field Details

  • 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

      protected ActionListWsDTO createActionListWsDTO(Collection<ActionData> actions)
    • 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 exists
      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
    • 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 invalid
      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
    • 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

      protected void validateAction(ActionData action)
    • validateActions

      protected void validateActions(ActionListWsDTO action)