de.hybris.platform.yacceleratorordermanagement.actions.consignment

Class VerifyConsignmentCompletionAction

java.lang.Object

de.hybris.platform.processengine.action.AbstractAction<ConsignmentProcessModel>

de.hybris.platform.yacceleratorordermanagement.actions.consignment.VerifyConsignmentCompletionAction

All Implemented Interfaces:

Action<ConsignmentProcessModel>

public class VerifyConsignmentCompletionAction
extends AbstractAction<ConsignmentProcessModel>

Checks the state of the consignment to performStrategy changes (e.g., setting the consignment status) according to the consignment's state changes resulted from the actions performed on it.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	VerifyConsignmentCompletionAction.Transition

Field Summary

Fields inherited from class de.hybris.platform.processengine.action.AbstractAction

modelService, processParameterHelper

Fields inherited from interface de.hybris.platform.processengine.spring.Action

ERROR_RETURN_CODE, RETRY_RETURN_CODE

Constructor Summary

Constructors

Constructor and Description
VerifyConsignmentCompletionAction()

Method Summary

Modifier and Type	Method and Description
java.lang.String	execute(ConsignmentProcessModel consignmentProcessModel) Executes this Action's business logic working on the given BusinessProcessModel.
java.util.Set<java.lang.String>	getTransitions() Accesses all possible return codes of this Action.
protected WarehousingConsignmentWorkflowService	getWarehousingConsignmentWorkflowService()
protected java.lang.String	okTransition(ConsignmentProcessModel consignmentProcess) Updates the ConsignmentModel.STATUS to ConsignmentStatus.CANCELLED
void	setWarehousingConsignmentWorkflowService(WarehousingConsignmentWorkflowService warehousingConsignmentWorkflowService)
protected void	updateConsignmentStatus(ConsignmentProcessModel consignmentProcessModel, ConsignmentStatus status) Updates the ConsignmentModel.STATUS to given ConsignmentStatus
protected java.lang.String	waitTransition(ConsignmentProcessModel consignmentProcess) Updates the ConsignmentModel.STATUS to ConsignmentStatus.READY.

Methods inherited from class de.hybris.platform.processengine.action.AbstractAction

createTransitions, getModelService, getProcessParameterHelper, getProcessParameterValue, refresh, save, setModelService, setOrderStatus, setProcessParameterHelper

Methods inherited from class java.lang.Object

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

Methods inherited from interface de.hybris.platform.processengine.spring.Action

getCurrentActionDefinitionContext

Constructor Detail

VerifyConsignmentCompletionAction

public VerifyConsignmentCompletionAction()

Method Detail

execute

public java.lang.String execute(ConsignmentProcessModel consignmentProcessModel)
                         throws java.lang.Exception

Description copied from interface: Action

Executes this Action's business logic working on the given BusinessProcessModel.

Parameters:

consignmentProcessModel - The process context to work on.

Returns:

the return code as stated in the process definition. This code is used by the process engine to determine the next actions.

Throws:

java.lang.Exception

waitTransition

protected java.lang.String waitTransition(ConsignmentProcessModel consignmentProcess)

Updates the ConsignmentModel.STATUS to ConsignmentStatus.READY.

Also, it assigns a new taskAssignment WorkflowModel to the ConsignmentModel and puts the ConsignmentProcessModel in waiting state

Parameters:

consignmentProcess - the given ConsignmentProcessModel

Returns:

the VerifyConsignmentCompletionAction.Transition.WAIT

okTransition

protected java.lang.String okTransition(ConsignmentProcessModel consignmentProcess)

Updates the ConsignmentModel.STATUS to ConsignmentStatus.CANCELLED

Parameters:

consignmentProcess - the given ConsignmentProcessModel

Returns:

the VerifyConsignmentCompletionAction.Transition.OK

updateConsignmentStatus

protected void updateConsignmentStatus(ConsignmentProcessModel consignmentProcessModel,
                                       ConsignmentStatus status)

Updates the ConsignmentModel.STATUS to given ConsignmentStatus

Parameters:

consignmentProcessModel - the given ConsignmentProcessModel

status - The ConsignmentStatus to be set on the ConsignmentModel

getTransitions

public java.util.Set<java.lang.String> getTransitions()

Description copied from interface: Action

Accesses all possible return codes of this Action. This method is used by the process engine to validate a process definition. Furthermore it can be used by (graphical) editors to access all return codes which have to mapped in transitions.

Returns:

all possible return codes of this Action

getWarehousingConsignmentWorkflowService

protected WarehousingConsignmentWorkflowService getWarehousingConsignmentWorkflowService()

setWarehousingConsignmentWorkflowService

public void setWarehousingConsignmentWorkflowService(WarehousingConsignmentWorkflowService warehousingConsignmentWorkflowService)