WorkflowService (hybris Commerce Suite 6.3.0.0-SNAPSHOT)

All Known Implementing Classes:

WorkflowServiceImpl

Deprecated.
as of release 4.3, please use WorkflowService
```
@Deprecated
public interface WorkflowService
```

Field Summary

Fields
Modifier and Type Field and Description

static String ACTION_CREATE
Deprecated.

static String ACTION_REMOVE
Deprecated.

static String ACTION_SAVE
Deprecated.

Fields
Modifier and Type	Field and Description
`static String`	`ACTION_CREATE` Deprecated.
`static String`	`ACTION_REMOVE` Deprecated.
`static String`	`ACTION_SAVE` Deprecated.

Method Summary

All Methods Instance Methods Abstract Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`addComment(Object comment, WorkflowActionModel action)` Deprecated. as of release 4.3, please use `WorkflowActionCommentService.addCommentToAction(String, WorkflowActionModel)`
`void`	`addItems(ItemModel workflowModel, List<ItemModel> itemsToAdd)` Deprecated. as of release 4.3, please use `WorkflowAttachmentService.addItems(WorkflowModel, List)` adds given items to given workflow
`void`	`assignUser(PrincipalModel principalModel, WorkflowModel workflow)` Deprecated. as of release 4.3, please use `WorkflowService.assignUser(PrincipalModel, WorkflowModel)`
`boolean`	`canBeStarted(WorkflowModel workf)` Deprecated. as of release 4.3, please use `WorkflowService.canBeStarted(WorkflowModel)`
`ItemModel`	`containsItem(ItemModel modelData, List<ItemModel> itemsToAdd)` Deprecated. as of release 4.3, please use `WorkflowAttachmentService.containsItem(WorkflowModel, List)` Checks if given workflow has one of given items attached.
`WorkflowModel`	`createAdhocWorkflow(String defaultName, List<ItemModel> itemsToAdd)` Deprecated. as of release 4.3, please use `WorkflowService.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.
`WorkflowModel`	`createWorkflow(String workflowName, WorkflowTemplateModel template, List<ItemModel> itemsToAdd)` Deprecated. as of release 4.3, please use `WorkflowService.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.
`WorkflowModel`	`createWorkflow(WorkflowTemplateModel templateModel, ItemModel itemModel)` Deprecated. as of release 4.3, please use `WorkflowService.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.
`void`	`decideAction(WorkflowActionModel action, WorkflowDecisionModel decision)` Deprecated. as of release 4.3, please use `WorkflowProcessingService.decideAction(WorkflowActionModel, WorkflowDecisionModel)`
`void`	`evaluteActivationScripts(ItemModel item, Map currentValues, Map initialValues, String action)` Deprecated. as of release 4.3, please use `ScriptEvaluationService.evaluateActivationScripts(ItemModel, Map, Map, String)`
`List<WorkflowActionModel>`	`getAllUserWorkflowActionsWithAttachment(ComposedType attachmentType)` Deprecated. as of release 4.3, please use `WorkflowActionService.getAllUserWorkflowActionsWithAttachment(de.hybris.platform.core.model.type.ComposedTypeModel)`
`List<WorkflowActionModel>`	`getAllUserWorkflowActionsWithAttachment(String attachmentClassName)` Deprecated. as of release 4.3, please use `WorkflowActionService.getAllUserWorkflowActionsWithAttachment(String)`
`List<WorkflowActionModel>`	`getAllUserWorkflowActionsWithAttachments(List<String> attachmentClassNames)` Deprecated. as of release 4.3, please use `WorkflowActionService.getAllUserWorkflowActionsWithAttachments(List)`
`List<WorkflowActionModel>`	`getAllUserWorkflowActionsWithAttachments(List<String> attachmentClassNames, Collection<WorkflowActionStatus> actionStatuses)` Deprecated.
`List<WorkflowTemplateModel>`	`getAllVisibleWorkflowTemplates()` Deprecated. as of release 4.3, please use `WorkflowTemplateService.getAllVisibleWorkflowTemplatesForUser(de.hybris.platform.core.model.user.UserModel)`
`List<WorkflowModel>`	`getAllWorkflows(int workflowsStatuses, int adhocWorkflowsStatuses, Date dateFrom, Date dateTo, Date adhocFilterFrom, Date adhocFilterTo)` Deprecated. as of release 4.3, please use `WorkflowService.getAllWorkflows(java.util.EnumSet, Date, Date)` and `WorkflowService.getAllAdhocWorkflows(java.util.EnumSet, Date, Date)`
`List<WorkflowTemplateModel>`	`getAllWorkflowTemplates()` Deprecated. as of release 4.3, please use `WorkflowTemplateService.getAllWorkflowTemplates()`
`List<ItemModel>`	`getAttachmentsForAction(WorkflowActionModel action)` Deprecated. as of release 4.3, please use `WorkflowAttachmentService.getAttachmentsForAction(WorkflowActionModel)`
`List<ItemModel>`	`getAttachmentsForAction(WorkflowActionModel action, List<String> attachmentClassNames)` Deprecated. as of release 4.3, please use `WorkflowAttachmentService.getAttachmentsForAction(WorkflowActionModel,List)`
`List<ItemModel>`	`getAttachmentsForAction(WorkflowActionModel action, String attachmentClassName)` Deprecated. as of release 4.3, please use `WorkflowAttachmentService.getAttachmentsForAction(WorkflowActionModel,String)`
`List<WorkflowActionCommentModel>`	`getCommentsForAction(WorkflowActionModel action)` Deprecated. as of release 4.3, please use `AbstractWorkflowActionModel.getWorkflowActionComments()`
`List<WorkflowDecisionModel>`	`getDecisionsForAction(WorkflowActionModel action)` Deprecated. as of release 4.3, please use `WorkflowActionModel.getDecisions()`
`List<WorkflowActionModel>`	`getEndWorkflowActions(WorkflowModel wfModel)` Deprecated. as of release 4.3, please use `WorkflowActionService.getEndWorkflowActions(WorkflowModel)`
`List<WorkflowActionModel>`	`getNormalWorkflowActions(WorkflowModel wfModel)` Deprecated. as of release 4.3, please use `WorkflowActionService.getNormalWorkflowActions(WorkflowModel)`
`Date`	`getStartTime(WorkflowModel workflow)` Deprecated. as of release 4.3, please use `WorkflowService.getStartTime(WorkflowModel)`
`List<WorkflowActionModel>`	`getStartWorkflowActions(WorkflowModel workflowModel)` Deprecated. as of release 4.3, please use `WorkflowActionService.getStartWorkflowActions(WorkflowModel)`
`List<WorkflowActionModel>`	`getWorkflowActionsByType(EnumerationValue type, WorkflowModel wfModel)` Deprecated. as of release 4.3, please use `WorkflowActionService.getWorkflowActionsByType(de.hybris.platform.workflow.enums.WorkflowActionType, WorkflowModel)`
`List<WorkflowModel>`	`getWorkflowsByTemplate(WorkflowTemplateModel template)` Deprecated. as of release 4.3, please use `WorkflowService.getWorkflowsForTemplateAndUser(WorkflowTemplateModel,de.hybris.platform.core.model.user.UserModel)`
`boolean`	`isAdhocWorkflow(WorkflowModel workflow)` Deprecated. as of release 4.3, please use `WorkflowService.isAdhocWorkflow(WorkflowModel)`
`boolean`	`isAutomatedComment(WorkflowActionCommentModel comment)` Deprecated. as of release 4.3, please use `WorkflowActionCommentService.isAutomatedComment(WorkflowActionCommentModel)`
`boolean`	`isFinished(Object workflowModel)` Deprecated. as of release 4.3, please use `WorkflowService.isFinished(WorkflowModel)`
`boolean`	`isPaused(Object workflowModel)` Deprecated. as of release 4.3, please use `WorkflowService.isPaused(WorkflowModel)`
`boolean`	`isPlanned(Object workflowModel)` Deprecated. as of release 4.3, please use `WorkflowService.isPlanned(WorkflowModel)`
`boolean`	`isRunning(Object workflowModel)` Deprecated.
`boolean`	`isTerminated(Object workflowModel)` Deprecated. as of release 4.3, please use `WorkflowService.isTerminated(WorkflowModel)`
`void`	`startWorkflow(ItemModel workflowModel)` Deprecated. as of release 4.3, please use `WorkflowProcessingService.startWorkflow(WorkflowModel)` starts given (adhoc) workflow
`void`	`terminateWorkflow(ItemModel workflowModel)` Deprecated.
`void`	`unassignUser(PrincipalModel principalModel, WorkflowModel workflow)` Deprecated. as of release 4.3, please use `WorkflowService.unassignUser(WorkflowModel)`

- Field Detail
  - ACTION_CREATE
```
static final String ACTION_CREATE
```
    Deprecated.
    
    See Also:
    
    Constant Field Values
  - ACTION_REMOVE
```
static final String ACTION_REMOVE
```
    Deprecated.
    
    See Also:
    
    Constant Field Values
  - ACTION_SAVE
```
static final String ACTION_SAVE
```
    Deprecated.
    
    See Also:
    
    Constant Field Values
- Method Detail
  - getAllUserWorkflowActionsWithAttachment
```
@Deprecated
List<WorkflowActionModel> getAllUserWorkflowActionsWithAttachment(String attachmentClassName)
```
    Deprecated. as of release 4.3, please use WorkflowActionService.getAllUserWorkflowActionsWithAttachment(String)
  - getAllUserWorkflowActionsWithAttachment
```
@Deprecated
List<WorkflowActionModel> getAllUserWorkflowActionsWithAttachment(ComposedType attachmentType)
```
    Deprecated. as of release 4.3, please use WorkflowActionService.getAllUserWorkflowActionsWithAttachment(de.hybris.platform.core.model.type.ComposedTypeModel)
  - getAllUserWorkflowActionsWithAttachments
```
@Deprecated
List<WorkflowActionModel> getAllUserWorkflowActionsWithAttachments(List<String> attachmentClassNames)
```
    Deprecated. as of release 4.3, please use WorkflowActionService.getAllUserWorkflowActionsWithAttachments(List)
  - getAllUserWorkflowActionsWithAttachments
```
@Deprecated
List<WorkflowActionModel> getAllUserWorkflowActionsWithAttachments(List<String> attachmentClassNames,
                                                                               Collection<WorkflowActionStatus> actionStatuses)
```
    Deprecated.
    
    * @deprecated as of release 4.3, please use WorkflowActionService.getAllUserWorkflowActionsWithAttachments(List, Collection) Retrieves workflow actions with specified criteria.
    
    Parameters:
    
    attachmentClassNames - list of allowed attachment class names
    
    actionStatuses - allowed action statuses
    
    Returns:
    
    list of workflow actions
  - getCommentsForAction
```
@Deprecated
List<WorkflowActionCommentModel> getCommentsForAction(WorkflowActionModel action)
```
    Deprecated. as of release 4.3, please use AbstractWorkflowActionModel.getWorkflowActionComments()
  - getAttachmentsForAction
```
@Deprecated
List<ItemModel> getAttachmentsForAction(WorkflowActionModel action)
```
    Deprecated. as of release 4.3, please use WorkflowAttachmentService.getAttachmentsForAction(WorkflowActionModel)
  - getAttachmentsForAction
```
@Deprecated
List<ItemModel> getAttachmentsForAction(WorkflowActionModel action,
                                                    String attachmentClassName)
```
    Deprecated. as of release 4.3, please use WorkflowAttachmentService.getAttachmentsForAction(WorkflowActionModel,String)
  - getAttachmentsForAction
```
@Deprecated
List<ItemModel> getAttachmentsForAction(WorkflowActionModel action,
                                                    List<String> attachmentClassNames)
```
    Deprecated. as of release 4.3, please use WorkflowAttachmentService.getAttachmentsForAction(WorkflowActionModel,List)
  - getDecisionsForAction
```
@Deprecated
List<WorkflowDecisionModel> getDecisionsForAction(WorkflowActionModel action)
```
    Deprecated. as of release 4.3, please use WorkflowActionModel.getDecisions()
  - decideAction
```
@Deprecated
void decideAction(WorkflowActionModel action,
                              WorkflowDecisionModel decision)
```
    Deprecated. as of release 4.3, please use WorkflowProcessingService.decideAction(WorkflowActionModel, WorkflowDecisionModel)
  - addComment
```
@Deprecated
void addComment(Object comment,
                            WorkflowActionModel action)
```
    Deprecated. as of release 4.3, please use WorkflowActionCommentService.addCommentToAction(String, WorkflowActionModel)
  - evaluteActivationScripts
```
@Deprecated
void evaluteActivationScripts(ItemModel item,
                                          Map currentValues,
                                          Map initialValues,
                                          String action)
```
    Deprecated. as of release 4.3, please use ScriptEvaluationService.evaluateActivationScripts(ItemModel, Map, Map, String)
  - createWorkflow
```
@Deprecated
WorkflowModel createWorkflow(WorkflowTemplateModel templateModel,
                                         ItemModel itemModel)
```
    Deprecated. as of release 4.3, please use WorkflowService.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
WorkflowModel createWorkflow(String workflowName,
                                         WorkflowTemplateModel template,
                                         List<ItemModel> itemsToAdd)
```
    Deprecated. as of release 4.3, please use WorkflowService.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
boolean isAutomatedComment(WorkflowActionCommentModel comment)
```
    Deprecated. as of release 4.3, please use WorkflowActionCommentService.isAutomatedComment(WorkflowActionCommentModel)
  - getAllWorkflowTemplates
```
@Deprecated
List<WorkflowTemplateModel> getAllWorkflowTemplates()
```
    Deprecated. as of release 4.3, please use WorkflowTemplateService.getAllWorkflowTemplates()
  - getWorkflowsByTemplate
```
@Deprecated
List<WorkflowModel> getWorkflowsByTemplate(WorkflowTemplateModel template)
```
    Deprecated. as of release 4.3, please use WorkflowService.getWorkflowsForTemplateAndUser(WorkflowTemplateModel,de.hybris.platform.core.model.user.UserModel)
  - getAllWorkflows
```
@Deprecated
List<WorkflowModel> getAllWorkflows(int workflowsStatuses,
                                                int adhocWorkflowsStatuses,
                                                Date dateFrom,
                                                Date dateTo,
                                                Date adhocFilterFrom,
                                                Date adhocFilterTo)
```
    Deprecated. as of release 4.3, please use WorkflowService.getAllWorkflows(java.util.EnumSet, Date, Date) and WorkflowService.getAllAdhocWorkflows(java.util.EnumSet, Date, Date)
    
    Parameters:
    
    workflowsStatuses - 0 - all, see WorkflowConstants.WorkflowStatus for other values
    
    adhocWorkflowsStatuses - 0 - all, see WorkflowConstants.WorkflowStatus for 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
WorkflowModel createAdhocWorkflow(String defaultName,
                                              List<ItemModel> itemsToAdd)
```
    Deprecated. as of release 4.3, please use WorkflowService.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 add
    
    defaultName - of adhoc workflow
    
    Returns:
    
    created adhoc workflow
  - assignUser
```
@Deprecated
void assignUser(PrincipalModel principalModel,
                            WorkflowModel workflow)
```
    Deprecated. as of release 4.3, please use WorkflowService.assignUser(PrincipalModel, WorkflowModel)
    
    Parameters:
    
    principalModel - to assign to given workflow
  - getAllVisibleWorkflowTemplates
```
@Deprecated
List<WorkflowTemplateModel> getAllVisibleWorkflowTemplates()
```
    Deprecated. as of release 4.3, please use WorkflowTemplateService.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
boolean isPaused(Object workflowModel)
```
    Deprecated. as of release 4.3, please use WorkflowService.isPaused(WorkflowModel)
    
    Parameters:
    
    workflowModel - or adhoc workflow model
    
    Returns:
    
    true if workflow is paused
  - startWorkflow
```
@Deprecated
void startWorkflow(ItemModel workflowModel)
```
    Deprecated. as of release 4.3, please use WorkflowProcessingService.startWorkflow(WorkflowModel) starts given (adhoc) workflow
  - terminateWorkflow
```
@Deprecated
void terminateWorkflow(ItemModel workflowModel)
```
    Deprecated.
    
    * @deprecated as of release 4.3, please use WorkflowProcessingService.terminateWorkflow(WorkflowModel) terminate given (adhoc) workflow
  - isTerminated
```
@Deprecated
boolean isTerminated(Object workflowModel)
```
    Deprecated. as of release 4.3, please use WorkflowService.isTerminated(WorkflowModel)
    
    Parameters:
    
    workflowModel - or adhoc workflow model
    
    Returns:
    
    true if workflow is terminated
  - isRunning
```
@Deprecated
boolean isRunning(Object workflowModel)
```
    Deprecated.
    
    * @deprecated as of release 4.3, please use WorkflowService.isRunning(WorkflowModel)
    
    Parameters:
    
    workflowModel - or adhoc workflow model
    
    Returns:
    
    true if workflow is running
  - isFinished
```
@Deprecated
boolean isFinished(Object workflowModel)
```
    Deprecated. as of release 4.3, please use WorkflowService.isFinished(WorkflowModel)
    
    Parameters:
    
    workflowModel - or adhoc workflow model
    
    Returns:
    
    true if workflow is finished
  - isPlanned
```
@Deprecated
boolean isPlanned(Object workflowModel)
```
    Deprecated. as of release 4.3, please use WorkflowService.isPlanned(WorkflowModel)
    
    Parameters:
    
    workflowModel - or adhoc workflow model
    
    Returns:
    
    true if workflow is planned
  - addItems
```
@Deprecated
void addItems(ItemModel workflowModel,
                          List<ItemModel> itemsToAdd)
```
    Deprecated. as of release 4.3, please use WorkflowAttachmentService.addItems(WorkflowModel, List) adds given items to given workflow
  - containsItem
```
@Deprecated
ItemModel containsItem(ItemModel modelData,
                                   List<ItemModel> itemsToAdd)
```
    Deprecated. as of release 4.3, please use WorkflowAttachmentService.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
boolean isAdhocWorkflow(WorkflowModel workflow)
```
    Deprecated. as of release 4.3, please use WorkflowService.isAdhocWorkflow(WorkflowModel)
    
    Returns:
    
    true if given workflow was created out of adhoc-workflow template
  - canBeStarted
```
@Deprecated
boolean canBeStarted(WorkflowModel workf)
```
    Deprecated. as of release 4.3, please use WorkflowService.canBeStarted(WorkflowModel)
    
    Returns:
    
    true if given workflow can be started, false otherwise (e.g. when there are is no user assigned)
  - getStartTime
```
@Deprecated
Date getStartTime(WorkflowModel workflow)
```
    Deprecated. as of release 4.3, please use WorkflowService.getStartTime(WorkflowModel)
    
    Returns:
    
    start time of given workflow
  - unassignUser
```
@Deprecated
void unassignUser(PrincipalModel principalModel,
                              WorkflowModel workflow)
```
    Deprecated. as of release 4.3, please use WorkflowService.unassignUser(WorkflowModel)
    
    Parameters:
    
    principalModel - to unassign from given adhoc workflow
  - getStartWorkflowActions
```
@Deprecated
List<WorkflowActionModel> getStartWorkflowActions(WorkflowModel workflowModel)
```
    Deprecated. as of release 4.3, please use WorkflowActionService.getStartWorkflowActions(WorkflowModel)
    
    Returns:
    
    all workflow actions that are marked as 'start action'
  - getNormalWorkflowActions
```
@Deprecated
List<WorkflowActionModel> getNormalWorkflowActions(WorkflowModel wfModel)
```
    Deprecated. as of release 4.3, please use WorkflowActionService.getNormalWorkflowActions(WorkflowModel)
    
    Returns:
    
    all workflow actions that are marked as 'normal action'
  - getEndWorkflowActions
```
@Deprecated
List<WorkflowActionModel> getEndWorkflowActions(WorkflowModel wfModel)
```
    Deprecated. as of release 4.3, please use WorkflowActionService.getEndWorkflowActions(WorkflowModel)
    
    Returns:
    
    all workflow actions that are marked as 'end action'
  - getWorkflowActionsByType
```
@Deprecated
List<WorkflowActionModel> getWorkflowActionsByType(EnumerationValue type,
                                                               WorkflowModel wfModel)
```
    Deprecated. as of release 4.3, please use WorkflowActionService.getWorkflowActionsByType(de.hybris.platform.workflow.enums.WorkflowActionType, WorkflowModel)
    
    Returns:
    
    all workflow actions which are of given type

Interface WorkflowService

Field Summary

Method Summary

Field Detail

ACTION_CREATE

ACTION_REMOVE

ACTION_SAVE

Method Detail

getAllUserWorkflowActionsWithAttachment

getAllUserWorkflowActionsWithAttachment

getAllUserWorkflowActionsWithAttachments

getAllUserWorkflowActionsWithAttachments

getCommentsForAction

getAttachmentsForAction

getAttachmentsForAction

getAttachmentsForAction

getDecisionsForAction

decideAction

addComment

evaluteActivationScripts

createWorkflow

createWorkflow

isAutomatedComment

getAllWorkflowTemplates

getWorkflowsByTemplate

getAllWorkflows

createAdhocWorkflow

assignUser

getAllVisibleWorkflowTemplates

isPaused

startWorkflow

terminateWorkflow

isTerminated

isRunning

isFinished

isPlanned

addItems

containsItem

isAdhocWorkflow

canBeStarted

getStartTime

unassignUser

getStartWorkflowActions

getNormalWorkflowActions

getEndWorkflowActions

getWorkflowActionsByType