Interface OmsWorkflowFacade
- All Known Implementing Classes:
DefaultOmsWorkflowFacade
public interface OmsWorkflowFacade
Order management facade exposing operations related to
WorkflowModel-
Method Summary
Modifier and TypeMethodDescriptionvoiddecideAction(String workflowCode, String workflowDecisionCode) Decides theWorkflowActionModelwith the providedAbstractWorkflowDecisionModel.NAMEvoiddecideActions(WorkflowCodesDataList workflowCodes, String workflowDecisionCode) Decides a list of workflows containing actions with the provided workflow decision nameAPI to get all active workflow actions for the current user in the systemstartErrorRecoveryWorkflow(ItemModel item, String workflowName, String workflowTemplateCode, String userGroupUid, String errorType, String errorDescription) Creates and starts an error recovery workflow with the given template for the givenItemModel.startWorkflow(ItemModel item, String workflowName, String workflowTemplateCode, String userGroupUid) Creates and starts a workflow with the given template for the givenItemModel.
-
Method Details
-
startErrorRecoveryWorkflow
WorkflowData startErrorRecoveryWorkflow(ItemModel item, String workflowName, String workflowTemplateCode, String userGroupUid, String errorType, String errorDescription) Creates and starts an error recovery workflow with the given template for the givenItemModel.- Parameters:
item- theItemModelfor which to start the workflowworkflowName- name given to the workflow at creation timeworkflowTemplateCode- template code of the workflow to be starteduserGroupUid- the uid of the group to be assigned to the workflow actionserrorType- the type of the error. ThisStringwill be persisted inside of the created workflowerrorDescription- the description of the error. ThisStringwill be persisted inside of the created workflow- Returns:
- instance of created
WorkflowData
-
startWorkflow
WorkflowData startWorkflow(ItemModel item, String workflowName, String workflowTemplateCode, String userGroupUid) Creates and starts a workflow with the given template for the givenItemModel.- Parameters:
item- theItemModelfor which to start the workflowworkflowName- name given to the workflow at creation timeworkflowTemplateCode- template code of the workflow to be starteduserGroupUid- the uid of the group to be assigned to the workflow actions- Returns:
- instance of created
WorkflowData
-
getWorkflowActions
List<WorkflowActionData> getWorkflowActions()API to get all active workflow actions for the current user in the system- Returns:
- a list of
WorkflowActionData
-
decideAction
Decides theWorkflowActionModelwith the providedAbstractWorkflowDecisionModel.NAME- Parameters:
workflowCode- theCronJobModel.CODEwhich the action belongs toworkflowDecisionCode- the decision to take on the action
-
decideActions
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 toworkflowDecisionCode- the decision to take on the actions
-