de.hybris.platform.processengine

Interface BusinessProcessService

All Known Subinterfaces:

WarehousingBusinessProcessService<T>

All Known Implementing Classes:

AbstractWarehousingBusinessProcessService, DefaultBusinessProcessService, DefaultConsignmentProcessService, DefaultOrderProcessService, DefaultReturnProcessService, MockBusinessProcessService

public interface BusinessProcessService

Manage business processes.

Method Summary

Modifier and Type	Method and Description
<T extends BusinessProcessModel> T	createProcess(java.lang.String processCode, java.lang.String processDefinitionName) Create process based on process definition.
<T extends BusinessProcessModel> T	createProcess(java.lang.String processCode, java.lang.String processDefinitionName, java.util.Map<java.lang.String,java.lang.Object> contextParameters) Create process based on process definition and add parameters to it.
<T extends BusinessProcessModel> T	getProcess(java.lang.String processCode) Find process by processCode.
void	restartProcess(BusinessProcessModel process, java.lang.String nodeId) Restart process.
void	startProcess(BusinessProcessModel businessProcessModel) Starts previously created process.
<T extends BusinessProcessModel> T	startProcess(java.lang.String processCode, java.lang.String processDefinitionName) Create and starts process basing on process definition.
<T extends BusinessProcessModel> T	startProcess(java.lang.String processCode, java.lang.String processDefinitionName, java.util.Map<java.lang.String,java.lang.Object> contextParameters) Create and starts process basing on process definition.
default boolean	triggerEvent(BusinessProcessEvent event) Trigger event
void	triggerEvent(BusinessProcessModel process, java.lang.String event) Deprecated. since ages - usetriggerEvent(String)
void	triggerEvent(java.lang.String event) Trigger event
void	triggerEvent(java.lang.String event, java.util.Date expirationDate) Trigger event

Method Detail

startProcess

<T extends BusinessProcessModel> T startProcess(java.lang.String processCode,
                                                java.lang.String processDefinitionName)

Create and starts process basing on process definition.

Parameters:

processCode - Id of newly created process.

processDefinitionName - Name of process definition used to create process (same like in process xml file).

Returns:

started process

startProcess

<T extends BusinessProcessModel> T startProcess(java.lang.String processCode,
                                                java.lang.String processDefinitionName,
                                                java.util.Map<java.lang.String,java.lang.Object> contextParameters)

Create and starts process basing on process definition. Additionally add parameters to process.

Parameters:

processCode - Id of newly created process.

processDefinitionName - Name of process definition used to create process (same like in process xml file).

contextParameters - Extra parameters map (can be used in example in actions).

Returns:

created process

startProcess

void startProcess(BusinessProcessModel businessProcessModel)

Starts previously created process.

Parameters:

businessProcessModel - Process that has to be started.

getProcess

<T extends BusinessProcessModel> T getProcess(java.lang.String processCode)

Find process by processCode.

Parameters:

processCode - id of needed process

Returns:

found process

triggerEvent

@Deprecated
void triggerEvent(BusinessProcessModel process,
                              java.lang.String event)

Deprecated. since ages - usetriggerEvent(String)

Trigger event on the process.

Parameters:

process - Process on which event will be fired.

event - Event name. Should be the same like in event node in process definition.

triggerEvent

void triggerEvent(java.lang.String event)

Trigger event

Parameters:

event - Event name. Should be the same like in event node in process definition.

triggerEvent

default boolean triggerEvent(BusinessProcessEvent event)

Trigger event

Parameters:

event - Event to be triggered.

Returns:

true if the operation succeeded or false if event has been already triggered.

triggerEvent

void triggerEvent(java.lang.String event,
                  java.util.Date expirationDate)

Trigger event

Parameters:

event - Event name. Should be the same like in event node in process definition.

expirationDate - Expiration Date. After this time Event will not be handled, and db will be cleared.

createProcess

<T extends BusinessProcessModel> T createProcess(java.lang.String processCode,
                                                 java.lang.String processDefinitionName,
                                                 java.util.Map<java.lang.String,java.lang.Object> contextParameters)

Create process based on process definition and add parameters to it.

Parameters:

processCode - Process Id.

processDefinitionName - Process definition (same like in process xml file).

contextParameters - map (parameter name, parameter value) of extra parameters.

Returns:

created process

createProcess

<T extends BusinessProcessModel> T createProcess(java.lang.String processCode,
                                                 java.lang.String processDefinitionName)

Create process based on process definition.

Parameters:

processCode - Process Id.

processDefinitionName - Process definition (same like in process xml file).

Returns:

created process

restartProcess

void restartProcess(BusinessProcessModel process,
                    java.lang.String nodeId)

Restart process.

Parameters:

process - Process to restart

nodeId - Id of the node to execute process on