Interface WorkflowService
- All Known Implementing Classes:
CmsWorkflowServiceImpl,WorkflowServiceImpl
Deprecated, for removal: This API element is subject to removal in a future version.
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final StringDeprecated, for removal: This API element is subject to removal in a future version.static final StringDeprecated, for removal: This API element is subject to removal in a future version.static final StringDeprecated, for removal: This API element is subject to removal in a future version. -
Method Summary
Modifier and TypeMethodDescriptionvoidaddComment(Object comment, WorkflowActionModel action) Deprecated, for removal: This API element is subject to removal in a future version.since ages - as of release 4.3, please useWorkflowActionCommentService.addCommentToAction(String, WorkflowActionModel)voidDeprecated, for removal: This API element is subject to removal in a future version.since ages - as of release 4.3, please useWorkflowAttachmentService.addItems(WorkflowModel, List)voidassignUser(PrincipalModel principalModel, WorkflowModel workflow) Deprecated, for removal: This API element is subject to removal in a future version.since ages - as of release 4.3, please useWorkflowService.assignUser(PrincipalModel, WorkflowModel)booleancanBeStarted(WorkflowModel workf) Deprecated, for removal: This API element is subject to removal in a future version.since ages - as of release 4.3, please useWorkflowService.canBeStarted(WorkflowModel)containsItem(ItemModel modelData, List<ItemModel> itemsToAdd) Deprecated, for removal: This API element is subject to removal in a future version.since ages - as of release 4.3, please useWorkflowAttachmentService.containsItem(WorkflowModel, List)createAdhocWorkflow(String defaultName, List<ItemModel> itemsToAdd) Deprecated, for removal: This API element is subject to removal in a future version.since ages - as of release 4.3, please useWorkflowService.createAdhocWorkflow(String, List, de.hybris.platform.core.model.user.UserModel)createWorkflow(WorkflowTemplateModel templateModel, ItemModel itemModel) Deprecated, for removal: This API element is subject to removal in a future version.since ages - as of release 4.3, please useWorkflowService.createWorkflow(WorkflowTemplateModel, ItemModel, de.hybris.platform.core.model.user.UserModel)createWorkflow(String workflowName, WorkflowTemplateModel template, List<ItemModel> itemsToAdd) Deprecated, for removal: This API element is subject to removal in a future version.since ages - as of release 4.3, please useWorkflowService.createWorkflow(String, WorkflowTemplateModel, List, de.hybris.platform.core.model.user.UserModel)voiddecideAction(WorkflowActionModel action, WorkflowDecisionModel decision) Deprecated, for removal: This API element is subject to removal in a future version.since ages - as of release 4.3, please useWorkflowProcessingService.decideAction(WorkflowActionModel, WorkflowDecisionModel)voidevaluteActivationScripts(ItemModel item, Map currentValues, Map initialValues, String action) Deprecated, for removal: This API element is subject to removal in a future version.since ages - as of release 4.3, please useScriptEvaluationService.evaluateActivationScripts(ItemModel, Map, Map, String)getAllUserWorkflowActionsWithAttachment(ComposedType attachmentType) Deprecated, for removal: This API element is subject to removal in a future version.since ages - as of release 4.3, please useWorkflowActionService.getAllUserWorkflowActionsWithAttachment(de.hybris.platform.core.model.type.ComposedTypeModel)getAllUserWorkflowActionsWithAttachment(String attachmentClassName) Deprecated, for removal: This API element is subject to removal in a future version.since ages - as of release 4.3, please useWorkflowActionService.getAllUserWorkflowActionsWithAttachment(String)getAllUserWorkflowActionsWithAttachments(List<String> attachmentClassNames) Deprecated, for removal: This API element is subject to removal in a future version.since ages - as of release 4.3, please useWorkflowActionService.getAllUserWorkflowActionsWithAttachments(List)getAllUserWorkflowActionsWithAttachments(List<String> attachmentClassNames, Collection<WorkflowActionStatus> actionStatuses) Deprecated, for removal: This API element is subject to removal in a future version.since agesDeprecated, for removal: This API element is subject to removal in a future version.since ages - as of release 4.3, please useWorkflowTemplateService.getAllVisibleWorkflowTemplatesForUser(de.hybris.platform.core.model.user.UserModel)getAllWorkflows(int workflowsStatuses, int adhocWorkflowsStatuses, Date dateFrom, Date dateTo, Date adhocFilterFrom, Date adhocFilterTo) Deprecated, for removal: This API element is subject to removal in a future version.since ages - as of release 4.3, please useWorkflowService.getAllWorkflows(java.util.EnumSet, Date, Date)andWorkflowService.getAllAdhocWorkflows(java.util.EnumSet, Date, Date)Deprecated, for removal: This API element is subject to removal in a future version.since ages - as of release 4.3, please useWorkflowTemplateService.getAllWorkflowTemplates()Deprecated, for removal: This API element is subject to removal in a future version.since ages - as of release 4.3, please useWorkflowAttachmentService.getAttachmentsForAction(WorkflowActionModel)getAttachmentsForAction(WorkflowActionModel action, String attachmentClassName) Deprecated, for removal: This API element is subject to removal in a future version.since ages - as of release 4.3, please useWorkflowAttachmentService.getAttachmentsForAction(WorkflowActionModel, String)getAttachmentsForAction(WorkflowActionModel action, List<String> attachmentClassNames) Deprecated, for removal: This API element is subject to removal in a future version.since ages - as of release 4.3, please useWorkflowAttachmentService.getAttachmentsForAction(WorkflowActionModel, List)Deprecated, for removal: This API element is subject to removal in a future version.since ages - as of release 4.3, please useAbstractWorkflowActionModel.getWorkflowActionComments()Deprecated, for removal: This API element is subject to removal in a future version.since ages - as of release 4.3, please useWorkflowActionModel.getDecisions()getEndWorkflowActions(WorkflowModel wfModel) Deprecated, for removal: This API element is subject to removal in a future version.since ages - as of release 4.3, please useWorkflowActionService.getEndWorkflowActions(WorkflowModel)getNormalWorkflowActions(WorkflowModel wfModel) Deprecated, for removal: This API element is subject to removal in a future version.since ages - as of release 4.3, please useWorkflowActionService.getNormalWorkflowActions(WorkflowModel)getStartTime(WorkflowModel workflow) Deprecated, for removal: This API element is subject to removal in a future version.since ages - as of release 4.3, please useWorkflowService.getStartTime(WorkflowModel)getStartWorkflowActions(WorkflowModel workflowModel) Deprecated, for removal: This API element is subject to removal in a future version.since ages - as of release 4.3, please useWorkflowActionService.getStartWorkflowActions(WorkflowModel)getWorkflowActionsByType(EnumerationValue type, WorkflowModel wfModel) Deprecated, for removal: This API element is subject to removal in a future version.since ages - as of release 4.3, please useWorkflowActionService.getWorkflowActionsByType(de.hybris.platform.workflow.enums.WorkflowActionType, WorkflowModel)getWorkflowsByTemplate(WorkflowTemplateModel template) Deprecated, for removal: This API element is subject to removal in a future version.since ages - as of release 4.3, please useWorkflowService.getWorkflowsForTemplateAndUser(WorkflowTemplateModel, de.hybris.platform.core.model.user.UserModel)booleanisAdhocWorkflow(WorkflowModel workflow) Deprecated, for removal: This API element is subject to removal in a future version.since ages - as of release 4.3, please useWorkflowService.isAdhocWorkflow(WorkflowModel)booleanDeprecated, for removal: This API element is subject to removal in a future version.since ages - as of release 4.3, please useWorkflowActionCommentService.isAutomatedComment(WorkflowActionCommentModel)booleanisFinished(Object workflowModel) Deprecated, for removal: This API element is subject to removal in a future version.since ages - as of release 4.3, please useWorkflowService.isFinished(WorkflowModel)booleanDeprecated, for removal: This API element is subject to removal in a future version.since ages - as of release 4.3, please useWorkflowService.isPaused(WorkflowModel)booleanDeprecated, for removal: This API element is subject to removal in a future version.since ages - as of release 4.3, please useWorkflowService.isPlanned(WorkflowModel)booleanDeprecated, for removal: This API element is subject to removal in a future version.since agesbooleanisTerminated(Object workflowModel) Deprecated, for removal: This API element is subject to removal in a future version.since ages - as of release 4.3, please useWorkflowService.isTerminated(WorkflowModel)voidstartWorkflow(ItemModel workflowModel) Deprecated, for removal: This API element is subject to removal in a future version.since ages - as of release 4.3, please useWorkflowProcessingService.startWorkflow(WorkflowModel)voidterminateWorkflow(ItemModel workflowModel) Deprecated, for removal: This API element is subject to removal in a future version.since agesvoidunassignUser(PrincipalModel principalModel, WorkflowModel workflow) Deprecated, for removal: This API element is subject to removal in a future version.since ages - as of release 4.3, please useWorkflowService.unassignUser(WorkflowModel)
-
Field Details
-
ACTION_CREATE
Deprecated, for removal: This API element is subject to removal in a future version.- See Also:
-
ACTION_REMOVE
Deprecated, for removal: This API element is subject to removal in a future version.- See Also:
-
ACTION_SAVE
Deprecated, for removal: This API element is subject to removal in a future version.- See Also:
-
-
Method Details
-
getAllUserWorkflowActionsWithAttachment
@Deprecated(since="ages", forRemoval=true) List<WorkflowActionModel> getAllUserWorkflowActionsWithAttachment(String attachmentClassName) Deprecated, for removal: This API element is subject to removal in a future version.since ages - as of release 4.3, please useWorkflowActionService.getAllUserWorkflowActionsWithAttachment(String) -
getAllUserWorkflowActionsWithAttachment
@Deprecated(since="ages", forRemoval=true) List<WorkflowActionModel> getAllUserWorkflowActionsWithAttachment(ComposedType attachmentType) Deprecated, for removal: This API element is subject to removal in a future version.since ages - as of release 4.3, please useWorkflowActionService.getAllUserWorkflowActionsWithAttachment(de.hybris.platform.core.model.type.ComposedTypeModel) -
getAllUserWorkflowActionsWithAttachments
@Deprecated(since="ages", forRemoval=true) List<WorkflowActionModel> getAllUserWorkflowActionsWithAttachments(List<String> attachmentClassNames) Deprecated, for removal: This API element is subject to removal in a future version.since ages - as of release 4.3, please useWorkflowActionService.getAllUserWorkflowActionsWithAttachments(List) -
getAllUserWorkflowActionsWithAttachments
@Deprecated(since="ages", forRemoval=true) List<WorkflowActionModel> getAllUserWorkflowActionsWithAttachments(List<String> attachmentClassNames, Collection<WorkflowActionStatus> actionStatuses) Deprecated, for removal: This API element is subject to removal in a future version.since ages* @deprecated as of release 4.3, please useWorkflowActionService.getAllUserWorkflowActionsWithAttachments(List, Collection)Retrieves workflow actions with specified criteria.
- Parameters:
attachmentClassNames- list of allowed attachment class namesactionStatuses- allowed action statuses- Returns:
- list of workflow actions
-
getCommentsForAction
@Deprecated(since="ages", forRemoval=true) List<WorkflowActionCommentModel> getCommentsForAction(WorkflowActionModel action) Deprecated, for removal: This API element is subject to removal in a future version.since ages - as of release 4.3, please useAbstractWorkflowActionModel.getWorkflowActionComments() -
getAttachmentsForAction
@Deprecated(since="ages", forRemoval=true) List<ItemModel> getAttachmentsForAction(WorkflowActionModel action) Deprecated, for removal: This API element is subject to removal in a future version.since ages - as of release 4.3, please useWorkflowAttachmentService.getAttachmentsForAction(WorkflowActionModel) -
getAttachmentsForAction
@Deprecated(since="ages", forRemoval=true) List<ItemModel> getAttachmentsForAction(WorkflowActionModel action, String attachmentClassName) Deprecated, for removal: This API element is subject to removal in a future version.since ages - as of release 4.3, please useWorkflowAttachmentService.getAttachmentsForAction(WorkflowActionModel, String) -
getAttachmentsForAction
@Deprecated(since="ages", forRemoval=true) List<ItemModel> getAttachmentsForAction(WorkflowActionModel action, List<String> attachmentClassNames) Deprecated, for removal: This API element is subject to removal in a future version.since ages - as of release 4.3, please useWorkflowAttachmentService.getAttachmentsForAction(WorkflowActionModel, List) -
getDecisionsForAction
@Deprecated(since="ages", forRemoval=true) List<WorkflowDecisionModel> getDecisionsForAction(WorkflowActionModel action) Deprecated, for removal: This API element is subject to removal in a future version.since ages - as of release 4.3, please useWorkflowActionModel.getDecisions() -
decideAction
@Deprecated(since="ages", forRemoval=true) void decideAction(WorkflowActionModel action, WorkflowDecisionModel decision) Deprecated, for removal: This API element is subject to removal in a future version.since ages - as of release 4.3, please useWorkflowProcessingService.decideAction(WorkflowActionModel, WorkflowDecisionModel) -
addComment
@Deprecated(since="ages", forRemoval=true) void addComment(Object comment, WorkflowActionModel action) Deprecated, for removal: This API element is subject to removal in a future version.since ages - as of release 4.3, please useWorkflowActionCommentService.addCommentToAction(String, WorkflowActionModel) -
evaluteActivationScripts
@Deprecated(since="ages", forRemoval=true) void evaluteActivationScripts(ItemModel item, Map currentValues, Map initialValues, String action) Deprecated, for removal: This API element is subject to removal in a future version.since ages - as of release 4.3, please useScriptEvaluationService.evaluateActivationScripts(ItemModel, Map, Map, String) -
createWorkflow
@Deprecated(since="ages", forRemoval=true) WorkflowModel createWorkflow(WorkflowTemplateModel templateModel, ItemModel itemModel) Deprecated, for removal: This API element is subject to removal in a future version.since ages - as of release 4.3, please useWorkflowService.createWorkflow(WorkflowTemplateModel, ItemModel, de.hybris.platform.core.model.user.UserModel)Creates workflow out of given template and starts it. Given item is attached to it.
-
createWorkflow
@Deprecated(since="ages", forRemoval=true) WorkflowModel createWorkflow(String workflowName, WorkflowTemplateModel template, List<ItemModel> itemsToAdd) Deprecated, for removal: This API element is subject to removal in a future version.since ages - as of release 4.3, please useWorkflowService.createWorkflow(String, WorkflowTemplateModel, List, de.hybris.platform.core.model.user.UserModel)Creates workflow out of given template with given name but does NOT start it. Given list of items is attached to it.
-
isAutomatedComment
@Deprecated(since="ages", forRemoval=true) boolean isAutomatedComment(WorkflowActionCommentModel comment) Deprecated, for removal: This API element is subject to removal in a future version.since ages - as of release 4.3, please useWorkflowActionCommentService.isAutomatedComment(WorkflowActionCommentModel) -
getAllWorkflowTemplates
Deprecated, for removal: This API element is subject to removal in a future version.since ages - as of release 4.3, please useWorkflowTemplateService.getAllWorkflowTemplates() -
getWorkflowsByTemplate
@Deprecated(since="ages", forRemoval=true) List<WorkflowModel> getWorkflowsByTemplate(WorkflowTemplateModel template) Deprecated, for removal: This API element is subject to removal in a future version.since ages - as of release 4.3, please useWorkflowService.getWorkflowsForTemplateAndUser(WorkflowTemplateModel, de.hybris.platform.core.model.user.UserModel) -
getAllWorkflows
@Deprecated(since="ages", forRemoval=true) List<WorkflowModel> getAllWorkflows(int workflowsStatuses, int adhocWorkflowsStatuses, Date dateFrom, Date dateTo, Date adhocFilterFrom, Date adhocFilterTo) Deprecated, for removal: This API element is subject to removal in a future version.since ages - as of release 4.3, please useWorkflowService.getAllWorkflows(java.util.EnumSet, Date, Date)andWorkflowService.getAllAdhocWorkflows(java.util.EnumSet, Date, Date)- Parameters:
workflowsStatuses- 0 - all, seeWorkflowConstants.WorkflowStatusfor other valuesadhocWorkflowsStatuses- 0 - all, seeWorkflowConstants.WorkflowStatusfor other values- Returns:
- List of workflows fulfilling given criteria, e.g. if only planned and running workflows should be returned then put 3 as workflowsStatuses and 0 for adhocWorkflowsStatuses.
-
createAdhocWorkflow
@Deprecated(since="ages", forRemoval=true) WorkflowModel createAdhocWorkflow(String defaultName, List<ItemModel> itemsToAdd) Deprecated, for removal: This API element is subject to removal in a future version.since ages - as of release 4.3, please useWorkflowService.createAdhocWorkflow(String, List, de.hybris.platform.core.model.user.UserModel)Creates adhoc workflow with given name, assigns given items to it and sets current user as owner.
- Parameters:
itemsToAdd- list of items to adddefaultName- of adhoc workflow- Returns:
- created adhoc workflow
-
assignUser
@Deprecated(since="ages", forRemoval=true) void assignUser(PrincipalModel principalModel, WorkflowModel workflow) Deprecated, for removal: This API element is subject to removal in a future version.since ages - as of release 4.3, please useWorkflowService.assignUser(PrincipalModel, WorkflowModel)- Parameters:
principalModel- to assign to given workflow
-
getAllVisibleWorkflowTemplates
@Deprecated(since="ages", forRemoval=true) List<WorkflowTemplateModel> getAllVisibleWorkflowTemplates()Deprecated, for removal: This API element is subject to removal in a future version.since ages - as of release 4.3, please useWorkflowTemplateService.getAllVisibleWorkflowTemplatesForUser(de.hybris.platform.core.model.user.UserModel)- Returns:
- all visible workflow templates for current session user, including templates that user is owner of, excluding special adhoc-workflow template
-
isPaused
Deprecated, for removal: This API element is subject to removal in a future version.since ages - as of release 4.3, please useWorkflowService.isPaused(WorkflowModel)- Parameters:
workflowModel- or adhoc workflow model- Returns:
- true if workflow is paused
-
startWorkflow
Deprecated, for removal: This API element is subject to removal in a future version.since ages - as of release 4.3, please useWorkflowProcessingService.startWorkflow(WorkflowModel)starts given (adhoc) workflow
-
terminateWorkflow
Deprecated, for removal: This API element is subject to removal in a future version.since ages* @deprecated as of release 4.3, please useWorkflowProcessingService.terminateWorkflow(WorkflowModel)terminate given (adhoc) workflow
-
isTerminated
Deprecated, for removal: This API element is subject to removal in a future version.since ages - as of release 4.3, please useWorkflowService.isTerminated(WorkflowModel)- Parameters:
workflowModel- or adhoc workflow model- Returns:
- true if workflow is terminated
-
isRunning
Deprecated, for removal: This API element is subject to removal in a future version.since ages* @deprecated as of release 4.3, please useWorkflowService.isRunning(WorkflowModel)- Parameters:
workflowModel- or adhoc workflow model- Returns:
- true if workflow is running
-
isFinished
Deprecated, for removal: This API element is subject to removal in a future version.since ages - as of release 4.3, please useWorkflowService.isFinished(WorkflowModel)- Parameters:
workflowModel- or adhoc workflow model- Returns:
- true if workflow is finished
-
isPlanned
Deprecated, for removal: This API element is subject to removal in a future version.since ages - as of release 4.3, please useWorkflowService.isPlanned(WorkflowModel)- Parameters:
workflowModel- or adhoc workflow model- Returns:
- true if workflow is planned
-
addItems
@Deprecated(since="ages", forRemoval=true) void addItems(ItemModel workflowModel, List<ItemModel> itemsToAdd) Deprecated, for removal: This API element is subject to removal in a future version.since ages - as of release 4.3, please useWorkflowAttachmentService.addItems(WorkflowModel, List)adds given items to given workflow
-
containsItem
@Deprecated(since="ages", forRemoval=true) ItemModel containsItem(ItemModel modelData, List<ItemModel> itemsToAdd) Deprecated, for removal: This API element is subject to removal in a future version.since ages - as of release 4.3, please useWorkflowAttachmentService.containsItem(WorkflowModel, List)Checks if given workflow has one of given items attached.
- Returns:
- first item from given list found in workflow, null otherwise
-
isAdhocWorkflow
Deprecated, for removal: This API element is subject to removal in a future version.since ages - as of release 4.3, please useWorkflowService.isAdhocWorkflow(WorkflowModel)- Returns:
- true if given workflow was created out of adhoc-workflow template
-
canBeStarted
Deprecated, for removal: This API element is subject to removal in a future version.since ages - as of release 4.3, please useWorkflowService.canBeStarted(WorkflowModel)- Returns:
- true if given workflow can be started, false otherwise (e.g. when there are is no user assigned)
-
getStartTime
Deprecated, for removal: This API element is subject to removal in a future version.since ages - as of release 4.3, please useWorkflowService.getStartTime(WorkflowModel)- Returns:
- start time of given workflow
-
unassignUser
@Deprecated(since="ages", forRemoval=true) void unassignUser(PrincipalModel principalModel, WorkflowModel workflow) Deprecated, for removal: This API element is subject to removal in a future version.since ages - as of release 4.3, please useWorkflowService.unassignUser(WorkflowModel)- Parameters:
principalModel- to unassign from given adhoc workflow
-
getStartWorkflowActions
@Deprecated(since="ages", forRemoval=true) List<WorkflowActionModel> getStartWorkflowActions(WorkflowModel workflowModel) Deprecated, for removal: This API element is subject to removal in a future version.since ages - as of release 4.3, please useWorkflowActionService.getStartWorkflowActions(WorkflowModel)- Returns:
- all workflow actions that are marked as 'start action'
-
getNormalWorkflowActions
@Deprecated(since="ages", forRemoval=true) List<WorkflowActionModel> getNormalWorkflowActions(WorkflowModel wfModel) Deprecated, for removal: This API element is subject to removal in a future version.since ages - as of release 4.3, please useWorkflowActionService.getNormalWorkflowActions(WorkflowModel)- Returns:
- all workflow actions that are marked as 'normal action'
-
getEndWorkflowActions
@Deprecated(since="ages", forRemoval=true) List<WorkflowActionModel> getEndWorkflowActions(WorkflowModel wfModel) Deprecated, for removal: This API element is subject to removal in a future version.since ages - as of release 4.3, please useWorkflowActionService.getEndWorkflowActions(WorkflowModel)- Returns:
- all workflow actions that are marked as 'end action'
-
getWorkflowActionsByType
@Deprecated(since="ages", forRemoval=true) List<WorkflowActionModel> getWorkflowActionsByType(EnumerationValue type, WorkflowModel wfModel) Deprecated, for removal: This API element is subject to removal in a future version.since ages - as of release 4.3, please useWorkflowActionService.getWorkflowActionsByType(de.hybris.platform.workflow.enums.WorkflowActionType, WorkflowModel)- Returns:
- all workflow actions which are of given type
-
WorkflowService