Package de.hybris.platform.ordermanagementwebservices.controllers.workflow

Class OmsWorkflowController

java.lang.Object

de.hybris.platform.ordermanagementwebservices.controllers.OmsBaseController

de.hybris.platform.ordermanagementwebservices.controllers.workflow.OmsWorkflowController

@Controller
@RequestMapping("/workflows")
public class OmsWorkflowController
extends OmsBaseController

WebResource exposing OmsWorkflowFacade https://host:port/ordermanagementwebservices/workflows

Field Summary

Fields inherited from class de.hybris.platform.ordermanagementwebservices.controllers.OmsBaseController

ADMIN_GROUP, CUSTOMER_SUPPORT_ADMINISTRATOR_GROUP, CUSTOMER_SUPPORT_AGENT_GROUP, CUSTOMER_SUPPORT_MANAGER_GROUP, dataMapper, DEFAULT_CURRENT_PAGE, DEFAULT_FIELD_SET, DEFAULT_PAGE_SIZE, DEFAULT_SORT

Constructor Summary

Constructors

Constructor	Description
OmsWorkflowController()

Method Summary

Modifier and Type	Method	Description
void	decideWorkflowAction(@NotNull java.lang.String workflowCode, @NotNull java.lang.String workflowDecisionCode)	Request to decide the workflow action belonging to the given workflow with the provided decision.
void	decideWorkflowActions(@NotNull WorkflowCodesListWsDto workflowCodesListWsDto, @NotNull java.lang.String workflowDecisionCode, java.lang.String fields)	Request to decide the workflow actions belonging to the given list of workflows with the provided decision.
protected OmsWorkflowFacade	getOmsWorkflowFacade()
WorkflowActionListWsDto	getWorkflowActions()	Request to get all active workflow actions assigned to the current user

Methods inherited from class de.hybris.platform.ordermanagementwebservices.controllers.OmsBaseController

createPageable, validate

Methods inherited from class java.lang.Object

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

Constructor Detail

OmsWorkflowController

public OmsWorkflowController()

Method Detail

getWorkflowActions

@RequestMapping(value="/actions",
                method=GET)
@ResponseBody
@Secured("ROLE_ADMINGROUP")
public WorkflowActionListWsDto getWorkflowActions()

Request to get all active workflow actions assigned to the current user

decideWorkflowAction

@RequestMapping(value="/{workflowCode}/{workflowDecisionCode}",
                method=POST,
                produces={"application/json","application/xml"},
                consumes={"application/json","application/xml"})
@ResponseStatus(OK)
@Secured("ROLE_ADMINGROUP")
public void decideWorkflowAction(@PathVariable @NotNull
                                 @NotNull java.lang.String workflowCode,
                                 @PathVariable @NotNull
                                 @NotNull java.lang.String workflowDecisionCode)

Request to decide the workflow action belonging to the given workflow with the provided decision.

Parameters:

workflowCode - the workflow which contains the action to be decided

workflowDecisionCode - the decision which is to be taken when the action is decided

decideWorkflowActions

@RequestMapping(value="/decide-action/{workflowDecisionCode}",
                method=POST,
                produces={"application/json","application/xml"},
                consumes={"application/json","application/xml"})
@ResponseStatus(OK)
@Secured("ROLE_ADMINGROUP")
public void decideWorkflowActions(@RequestBody @NotNull
                                  @NotNull WorkflowCodesListWsDto workflowCodesListWsDto,
                                  @PathVariable @NotNull
                                  @NotNull java.lang.String workflowDecisionCode,
                                  @RequestParam(required=false,defaultValue="DEFAULT")
                                  java.lang.String fields)

Request to decide the workflow actions belonging to the given list of workflows with the provided decision.

Parameters:

workflowCodesListWsDto - the list of codes for workflows containing actions to be decided

workflowDecisionCode - the decision which is to be taken when the action is decided

getOmsWorkflowFacade

protected OmsWorkflowFacade getOmsWorkflowFacade()