Package de.hybris.platform.ordermanagementfacades.workflow

Interface OmsWorkflowFacade

All Known Implementing Classes:

DefaultOmsWorkflowFacade

public interface OmsWorkflowFacade

Order management facade exposing operations related to WorkflowModel

Method Summary

Modifier and Type	Method	Description
void	decideAction(java.lang.String workflowCode, java.lang.String workflowDecisionCode)	Decides the WorkflowActionModel with the provided AbstractWorkflowDecisionModel.NAME
void	decideActions(WorkflowCodesDataList workflowCodes, java.lang.String workflowDecisionCode)	Decides a list of workflows containing actions with the provided workflow decision name
java.util.List<WorkflowActionData>	getWorkflowActions()	API to get all active workflow actions for the current user in the system
WorkflowData	startErrorRecoveryWorkflow(ItemModel item, java.lang.String workflowName, java.lang.String workflowTemplateCode, java.lang.String userGroupUid, java.lang.String errorType, java.lang.String errorDescription)	Creates and starts an error recovery workflow with the given template for the given ItemModel.
WorkflowData	startWorkflow(ItemModel item, java.lang.String workflowName, java.lang.String workflowTemplateCode, java.lang.String userGroupUid)	Creates and starts a workflow with the given template for the given ItemModel.

Method Detail

startErrorRecoveryWorkflow

WorkflowData startErrorRecoveryWorkflow(ItemModel item,
                                        java.lang.String workflowName,
                                        java.lang.String workflowTemplateCode,
                                        java.lang.String userGroupUid,
                                        java.lang.String errorType,
                                        java.lang.String errorDescription)

Creates and starts an error recovery workflow with the given template for the given ItemModel.

Parameters:

item - the ItemModel for which to start the workflow

workflowName - name given to the workflow at creation time

workflowTemplateCode - template code of the workflow to be started

userGroupUid - the uid of the group to be assigned to the workflow actions

errorType - the type of the error. This String will be persisted inside of the created workflow

errorDescription - the description of the error. This String will be persisted inside of the created workflow

Returns:

instance of created WorkflowData

startWorkflow

WorkflowData startWorkflow(ItemModel item,
                           java.lang.String workflowName,
                           java.lang.String workflowTemplateCode,
                           java.lang.String userGroupUid)

Creates and starts a workflow with the given template for the given ItemModel.

Parameters:

item - the ItemModel for which to start the workflow

workflowName - name given to the workflow at creation time

workflowTemplateCode - template code of the workflow to be started

userGroupUid - the uid of the group to be assigned to the workflow actions

Returns:

instance of created WorkflowData

getWorkflowActions

java.util.List<WorkflowActionData> getWorkflowActions()

API to get all active workflow actions for the current user in the system

Returns:

a list of WorkflowActionData

decideAction

void decideAction(java.lang.String workflowCode,
                  java.lang.String workflowDecisionCode)

Decides the WorkflowActionModel with the provided AbstractWorkflowDecisionModel.NAME

Parameters:

workflowCode - the CronJobModel.CODE which the action belongs to

workflowDecisionCode - the decision to take on the action

decideActions

void decideActions(WorkflowCodesDataList workflowCodes,
                   java.lang.String workflowDecisionCode)

Decides a list of workflows containing actions with the provided workflow decision name

Parameters:

workflowCodes - the WorkflowCodesDataList containing a list of workflow codes which the actions belong to

workflowDecisionCode - the decision to take on the actions