de.hybris.platform.warehousing.process

Interface WarehousingBusinessProcessService<T extends ItemModel>

Type Parameters:

T - The type of item that this business process service is used for.

All Superinterfaces:

BusinessProcessService

All Known Implementing Classes:

AbstractWarehousingBusinessProcessService, DefaultConsignmentProcessService, DefaultOrderProcessService, DefaultReturnProcessService

public interface WarehousingBusinessProcessService<T extends ItemModel>
extends BusinessProcessService

Service to simplify working with the BusinessProcessService.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getProcessCode(T item) Get the business process associated with an item
void	triggerChoiceEvent(T item, java.lang.String eventName, java.lang.String choice) Trigger a business process event to move a workflow out of a wait state.
void	triggerSimpleEvent(T item, java.lang.String eventName) Trigger a business process event to move a workflow out of a wait state.

Methods inherited from interface de.hybris.platform.processengine.BusinessProcessService

createProcess, createProcess, getProcess, restartProcess, startProcess, startProcess, startProcess, triggerEvent, triggerEvent, triggerEvent, triggerEvent

Method Detail

triggerSimpleEvent

void triggerSimpleEvent(T item,
                        java.lang.String eventName)

Trigger a business process event to move a workflow out of a wait state.

Parameters:

item - - the item being processed

eventName - - the name of the event to trigger

triggerChoiceEvent

void triggerChoiceEvent(T item,
                        java.lang.String eventName,
                        java.lang.String choice)
                 throws BusinessProcessException

Trigger a business process event to move a workflow out of a wait state. Also allows to specify which outbound flow to take.

Parameters:

item - - the item being processed

eventName - - the name of the event to trigger

choice - - the choice of the event to trigger

Throws:

BusinessProcessException - when the process cannot move to the requested state

getProcessCode

java.lang.String getProcessCode(T item)
                         throws BusinessProcessException

Get the business process associated with an item

Parameters:

item - - the item model

Returns:

the business process code

Throws:

BusinessProcessException - when no process can be found for the given item