de.hybris.platform.yacceleratorordermanagement.actions.consignment

Class ProcessConsignmentPreFulfillmentAction

java.lang.Object

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

de.hybris.platform.yacceleratorordermanagement.actions.consignment.ProcessConsignmentPreFulfillmentAction

All Implemented Interfaces:

Action<ConsignmentProcessModel>

public class ProcessConsignmentPreFulfillmentAction
extends AbstractAction<ConsignmentProcessModel>

Redirects the ConsignmentModel to wait node, if more pre fulfillment steps are required, else move to sendConsignmentToExternalFulfillmentSystem step in ConsignmentProcessModel.

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field and Description
protected static java.lang.String	LAST_EXECUTED_STRATEGY

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
ProcessConsignmentPreFulfillmentAction()

Method Summary

Modifier and Type	Method and Description
protected void	cleanStrategyContextParam(ConsignmentProcessModel consignmentProcess) Removes the strategy context param from BusinessProcessModel.CONTEXTPARAMETERS(if any exists), before attempting to set a new param
java.lang.String	execute(ConsignmentProcessModel consignmentProcess) Executes this Action's business logic working on the given BusinessProcessModel.
protected java.util.List<ConsignmentPreFulfillmentStrategy>	getConsignmentPreFulfillmentStrategies(ConsignmentModel consignment) Returns the list of ConsignmentPreFulfillmentStrategy(s), that needs to be applied on the given ConsignmentModel
protected ConsignmentPreFulfillmentStrategy	getLastExecutedConsignmentPreFulfillmentStrategy(ConsignmentProcessModel consignmentProcess, java.util.List<ConsignmentPreFulfillmentStrategy> consignmentPreFulfillmentStrategies) Evaluates the last executed ConsignmentPreFulfillmentStrategy for the given ConsignmentModel
protected java.util.Map<java.lang.String,java.util.List<ConsignmentPreFulfillmentStrategy>>	getPreFulfillmentStrategyRegistry()
java.util.Set<java.lang.String>	getTransitions() Accesses all possible return codes of this Action.
protected boolean	isTerminalStrategy(ConsignmentPreFulfillmentStrategy consignmentPreFulfillmentStrategy, java.util.List<ConsignmentPreFulfillmentStrategy> consignmentPreFulfillmentStrategies) Evaluates if the given ConsignmentPreFulfillmentStrategy is last pre fulfillment strategy to be executed
void	setPreFulfillmentStrategyRegistry(java.util.Map<java.lang.String,java.util.List<ConsignmentPreFulfillmentStrategy>> preFulfillmentStrategyRegistry)
protected void	setStrategyInContextParam(ConsignmentPreFulfillmentStrategy consignmentPreFulfillmentStrategy, ConsignmentProcessModel consignmentProcess) Sets the current executed ConsignmentPreFulfillmentStrategy in the context params of given ConsignmentProcessModel

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

Field Detail

LAST_EXECUTED_STRATEGY

protected static final java.lang.String LAST_EXECUTED_STRATEGY

See Also:

Constant Field Values

Constructor Detail

ProcessConsignmentPreFulfillmentAction

public ProcessConsignmentPreFulfillmentAction()

Method Detail

execute

public java.lang.String execute(ConsignmentProcessModel consignmentProcess)

Description copied from interface: Action

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

Parameters:

consignmentProcess - 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.

getConsignmentPreFulfillmentStrategies

protected java.util.List<ConsignmentPreFulfillmentStrategy> getConsignmentPreFulfillmentStrategies(ConsignmentModel consignment)

Returns the list of ConsignmentPreFulfillmentStrategy(s), that needs to be applied on the given ConsignmentModel

Parameters:

consignment - the ConsignmentModel

Returns:

the list of ConsignmentPreFulfillmentStrategy(s)

getLastExecutedConsignmentPreFulfillmentStrategy

protected ConsignmentPreFulfillmentStrategy getLastExecutedConsignmentPreFulfillmentStrategy(ConsignmentProcessModel consignmentProcess,
                                                                                             java.util.List<ConsignmentPreFulfillmentStrategy> consignmentPreFulfillmentStrategies)
                                                                                      throws java.lang.IllegalStateException

Evaluates the last executed ConsignmentPreFulfillmentStrategy for the given ConsignmentModel

Parameters:

consignmentProcess - the ConsignmentProcessModel

consignmentPreFulfillmentStrategies - the list of ConsignmentPreFulfillmentStrategy(s) to choose from

Returns:

the last executed ConsignmentPreFulfillmentStrategy.
Returns null, if no strategy was executed before

Throws:

java.lang.IllegalStateException - if the last executed ConsignmentPreFulfillmentStrategy is invalid

setStrategyInContextParam

protected void setStrategyInContextParam(ConsignmentPreFulfillmentStrategy consignmentPreFulfillmentStrategy,
                                         ConsignmentProcessModel consignmentProcess)

Sets the current executed ConsignmentPreFulfillmentStrategy in the context params of given ConsignmentProcessModel

Parameters:

consignmentPreFulfillmentStrategy - the ConsignmentPreFulfillmentStrategy

consignmentProcess - the ConsignmentProcessModel

cleanStrategyContextParam

protected void cleanStrategyContextParam(ConsignmentProcessModel consignmentProcess)

Removes the strategy context param from BusinessProcessModel.CONTEXTPARAMETERS(if any exists), before attempting to set a new param

Parameters:

consignmentProcess - the ConsignmentProcessModel for the consignment to be fulfilled

isTerminalStrategy

protected boolean isTerminalStrategy(ConsignmentPreFulfillmentStrategy consignmentPreFulfillmentStrategy,
                                     java.util.List<ConsignmentPreFulfillmentStrategy> consignmentPreFulfillmentStrategies)

Evaluates if the given ConsignmentPreFulfillmentStrategy is last pre fulfillment strategy to be executed

Parameters:

consignmentPreFulfillmentStrategy - the given ConsignmentPreFulfillmentStrategy to be checked

consignmentPreFulfillmentStrategies - the given list of ConsignmentPreFulfillmentStrategy(s) to check against

Returns:

true if there is no more strategy to be executed after this strategy

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

getPreFulfillmentStrategyRegistry

protected java.util.Map<java.lang.String,java.util.List<ConsignmentPreFulfillmentStrategy>> getPreFulfillmentStrategyRegistry()

setPreFulfillmentStrategyRegistry

public void setPreFulfillmentStrategyRegistry(java.util.Map<java.lang.String,java.util.List<ConsignmentPreFulfillmentStrategy>> preFulfillmentStrategyRegistry)