Package de.hybris.platform.cmswebservices.workflows.controller

Class CMSWorkflowController

java.lang.Object

de.hybris.platform.cmswebservices.workflows.controller.CMSWorkflowController

@Controller
@RequestMapping("/v1/catalogs/{catalogId}/versions/{versionId}/workflows")
public class CMSWorkflowController
extends java.lang.Object

Controller to manage workflows for CMSItems. catalogId and versionId are needed as part of the endpoint to set the activeCatalogVersion in the session which is later used by the workflow validators.

Constructor Summary

Constructors

Constructor	Description
CMSWorkflowController()

Method Summary

Modifier and Type	Method	Description
CMSWorkflowWsDTO	createWorkflow(CMSWorkflowWsDTO workflowInfo)
CMSWorkflowWsDTO	editWorkflow(java.lang.String workflowCode, CMSWorkflowWsDTO dto)
CMSWorkflowListWsDTO	findAllWorkflowsForAttachments(java.lang.String attachment, java.util.List<java.lang.String> statuses, PageableWsDTO pageableInfo)
protected CMSWorkflowFacade	getCmsWorkflowFacade()
protected DataMapper	getDataMapper()
protected WebPaginationUtils	getWebPaginationUtils()
CMSWorkflowWsDTO	getWorkflowByCode(java.lang.String workflowCode)
void	setCmsWorkflowFacade(CMSWorkflowFacade cmsWorkflowFacade)
void	setDataMapper(DataMapper dataMapper)
void	setWebPaginationUtils(WebPaginationUtils webPaginationUtils)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CMSWorkflowController

public CMSWorkflowController()

Method Detail

createWorkflow

@PostMapping
@ResponseStatus(CREATED)
@ResponseBody
public CMSWorkflowWsDTO createWorkflow(@RequestBody
                                       CMSWorkflowWsDTO workflowInfo)

editWorkflow

@PutMapping("/{workflowCode}")
@ResponseStatus(OK)
@ResponseBody
public CMSWorkflowWsDTO editWorkflow(@PathVariable
                                     java.lang.String workflowCode,
                                     @RequestBody
                                     CMSWorkflowWsDTO dto)
                              throws UnknownIdentifierException

Throws:

UnknownIdentifierException

findAllWorkflowsForAttachments

@GetMapping(params={"pageSize","currentPage"})
@ResponseStatus(OK)
@ResponseBody
public CMSWorkflowListWsDTO findAllWorkflowsForAttachments(@RequestParam(required=false)
                                                           java.lang.String attachment,
                                                           @RequestParam(required=false,defaultValue="RUNNING,PAUSED")
                                                           java.util.List<java.lang.String> statuses,
                                                           @ModelAttribute
                                                           PageableWsDTO pageableInfo)

getWorkflowByCode

@GetMapping("/{workflowCode}")
@ResponseStatus(OK)
@ResponseBody
public CMSWorkflowWsDTO getWorkflowByCode(@PathVariable
                                          java.lang.String workflowCode)

getDataMapper

protected DataMapper getDataMapper()

setDataMapper

public void setDataMapper(DataMapper dataMapper)

getCmsWorkflowFacade

protected CMSWorkflowFacade getCmsWorkflowFacade()

setCmsWorkflowFacade

public void setCmsWorkflowFacade(CMSWorkflowFacade cmsWorkflowFacade)

getWebPaginationUtils

protected WebPaginationUtils getWebPaginationUtils()

setWebPaginationUtils

public void setWebPaginationUtils(WebPaginationUtils webPaginationUtils)