Package de.hybris.platform.ordermanagementfacades.workflow.impl

Class DefaultOmsWorkflowFacade

java.lang.Object

de.hybris.platform.ordermanagementfacades.workflow.impl.DefaultOmsWorkflowFacade

All Implemented Interfaces:

OmsWorkflowFacade

public class DefaultOmsWorkflowFacade
extends java.lang.Object
implements OmsWorkflowFacade

Default implementation for OmsWorkflowFacade

Constructor Summary

Constructors

Constructor	Description
DefaultOmsWorkflowFacade()

Method Summary

Modifier and Type	Method	Description
protected WorkflowModel	createAndStartWorkflow(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.
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
protected ModelService	getModelService()
protected UserGroupModel	getUserGroupModel(java.lang.String userGroupUid)	Resolves the given group's uid to the UserGroupModel
protected UserService	getUserService()
protected Converter<WorkflowActionModel,WorkflowActionData>	getWorkflowActionConverter()
java.util.List<WorkflowActionData>	getWorkflowActions()	API to get all active workflow actions for the current user in the system
protected WorkflowActionService	getWorkflowActionService()
protected Converter<WorkflowModel,WorkflowData>	getWorkflowConverter()
protected WorkflowProcessingService	getWorkflowProcessingService()
protected WorkflowService	getWorkflowService()
protected WorkflowTemplateService	getWorkflowTemplateService()
void	setModelService(ModelService modelService)
void	setUserService(UserService userService)
void	setWorkflowActionConverter(Converter<WorkflowActionModel,WorkflowActionData> workflowActionConverter)
void	setWorkflowActionService(WorkflowActionService workflowActionService)
void	setWorkflowConverter(Converter<WorkflowModel,WorkflowData> workflowConverter)
void	setWorkflowProcessingService(WorkflowProcessingService workflowProcessingService)
void	setWorkflowService(WorkflowService workflowService)
void	setWorkflowTemplateService(WorkflowTemplateService workflowTemplateService)
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.

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultOmsWorkflowFacade

public DefaultOmsWorkflowFacade()

Method Detail

startErrorRecoveryWorkflow

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

Description copied from interface: OmsWorkflowFacade

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

Specified by:

startErrorRecoveryWorkflow in interface OmsWorkflowFacade

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

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

Description copied from interface: OmsWorkflowFacade

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

Specified by:

startWorkflow in interface OmsWorkflowFacade

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

public java.util.List<WorkflowActionData> getWorkflowActions()

Description copied from interface: OmsWorkflowFacade

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

Specified by:

getWorkflowActions in interface OmsWorkflowFacade

Returns:

a list of WorkflowActionData

decideAction

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

Description copied from interface: OmsWorkflowFacade

Decides the WorkflowActionModel with the provided AbstractWorkflowDecisionModel.NAME

Specified by:

decideAction in interface OmsWorkflowFacade

Parameters:

workflowCode - the CronJobModel.CODE which the action belongs to

workflowDecisionCode - the decision to take on the action

decideActions

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

Description copied from interface: OmsWorkflowFacade

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

Specified by:

decideActions in interface OmsWorkflowFacade

Parameters:

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

workflowDecisionCode - the decision to take on the actions

createAndStartWorkflow

protected WorkflowModel createAndStartWorkflow(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 WorkflowModel

getUserGroupModel

protected UserGroupModel getUserGroupModel(java.lang.String userGroupUid)

Resolves the given group's uid to the UserGroupModel

Parameters:

userGroupUid - the group's uid. If empty or null the method will return admin user group

Returns:

instance of UserGroupModel

getModelService

protected ModelService getModelService()

setModelService

public void setModelService(ModelService modelService)

getWorkflowService

protected WorkflowService getWorkflowService()

setWorkflowService

public void setWorkflowService(WorkflowService workflowService)

getWorkflowTemplateService

protected WorkflowTemplateService getWorkflowTemplateService()

setWorkflowTemplateService

public void setWorkflowTemplateService(WorkflowTemplateService workflowTemplateService)

getWorkflowProcessingService

protected WorkflowProcessingService getWorkflowProcessingService()

setWorkflowProcessingService

public void setWorkflowProcessingService(WorkflowProcessingService workflowProcessingService)

getWorkflowActionService

protected WorkflowActionService getWorkflowActionService()

setWorkflowActionService

public void setWorkflowActionService(WorkflowActionService workflowActionService)

getUserService

protected UserService getUserService()

setUserService

public void setUserService(UserService userService)

getWorkflowConverter

protected Converter<WorkflowModel,WorkflowData> getWorkflowConverter()

setWorkflowConverter

public void setWorkflowConverter(Converter<WorkflowModel,WorkflowData> workflowConverter)

getWorkflowActionConverter

protected Converter<WorkflowActionModel,WorkflowActionData> getWorkflowActionConverter()

setWorkflowActionConverter

public void setWorkflowActionConverter(Converter<WorkflowActionModel,WorkflowActionData> workflowActionConverter)