de.hybris.platform.warehousing.taskassignment.services

Interface WarehousingConsignmentWorkflowService

All Known Implementing Classes:

DefaultWarehousingConsignmentWorkflowService

public interface WarehousingConsignmentWorkflowService

Warehousing service that creates and starts a consignment ConsignmentModel workflow.

Method Summary

Modifier and Type	Method and Description
void	decideWorkflowAction(ConsignmentModel consignment, java.lang.String templateCode, java.lang.String choice) Decides which WorkflowActionModel to trigger from a given ConsignmentModel and moves consignment's business process
WorkflowActionModel	getWorkflowActionForTemplateCode(java.lang.String templateCode, ConsignmentModel consignment) Returns the WorkflowActionModel of the given ConsignmentModel for the given JobModel.CODE
void	startConsignmentWorkflow(ConsignmentModel consignment) Starts a workflow for the given consignment ConsignmentModel.
void	terminateConsignmentWorkflow(ConsignmentModel consignment) Terminates a workflow assigned for the given consignment ConsignmentModel

Method Detail

startConsignmentWorkflow

void startConsignmentWorkflow(ConsignmentModel consignment)

Starts a workflow for the given consignment ConsignmentModel.

Parameters:

consignment - ConsignmentModel for which a workflow needs to be started

terminateConsignmentWorkflow

void terminateConsignmentWorkflow(ConsignmentModel consignment)

Terminates a workflow assigned for the given consignment ConsignmentModel

Parameters:

consignment - ConsignmentModel which we want to terminate the workflow for

decideWorkflowAction

void decideWorkflowAction(ConsignmentModel consignment,
                          java.lang.String templateCode,
                          java.lang.String choice)

Decides which WorkflowActionModel to trigger from a given ConsignmentModel and moves consignment's business process

Parameters:

consignment - the ConsignmentModel on which your action happened

templateCode - the JobModel.CODE

choice - the string code of the consignment's BusinessProcessModel choice to be processed

getWorkflowActionForTemplateCode

WorkflowActionModel getWorkflowActionForTemplateCode(java.lang.String templateCode,
                                                     ConsignmentModel consignment)

Returns the WorkflowActionModel of the given ConsignmentModel for the given JobModel.CODE

Parameters:

templateCode - the JobModel.CODE to retrieve

consignment - the ConsignmentModel for which the WorkflowActionModel is required

Returns:

the WorkflowActionModel