WorkflowActionService (hybris Commerce Suite 18.11)

All Known Implementing Classes:

DefaultWorkflowActionService
```
public interface WorkflowActionService
```
Service used to manipulate workflow actions. The main features are :
- fetch actions for various criteria
- create action based on some WorkflowActionTemplateModel
- check status of given workflow action
- modify status of given workflow action

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`WorkflowActionModel`	`complete(WorkflowActionModel action)` Completes action
`WorkflowActionModel`	`createWorkflowAction(WorkflowActionTemplateModel template, WorkflowModel workflow)` Creates workflow action based on template and attach it to workflow
`WorkflowActionModel`	`disable(WorkflowActionModel action)` Disable action
`WorkflowActionModel`	`getActionForCode(WorkflowModel workflow, java.lang.String code)`
`java.util.List<WorkflowActionModel>`	`getAllUserWorkflowActionsWithAttachment(ComposedTypeModel attachmentType)` Returns workflow actions with attachment that match type passed as a parameter
`java.util.List<WorkflowActionModel>`	`getAllUserWorkflowActionsWithAttachment(java.lang.String attachmentTypeCodeOrClassName)` Returns workflow actions with attachment that match type or code passed as a parameter
`java.util.List<WorkflowActionModel>`	`getAllUserWorkflowActionsWithAttachments(java.util.List<java.lang.String> attachments)` Returns workflow actions with attachment that match types passed
`java.util.List<WorkflowActionModel>`	`getAllUserWorkflowActionsWithAttachments(java.util.List<java.lang.String> attachments, java.util.Collection<WorkflowActionStatus> actionStatuses)` Returns workflow actions with attachment that match types passed and statuses
`java.util.List<WorkflowActionModel>`	`getEndWorkflowActions(WorkflowModel workflow)` Returns ended workflow actions
`java.util.List<WorkflowActionModel>`	`getNormalWorkflowActions(WorkflowModel workflow)` Returns normal workflow actions
`java.util.List<WorkflowActionModel>`	`getStartWorkflowActions(WorkflowModel workflow)` Returns start workflow actions
`java.util.List<WorkflowActionModel>`	`getWorkflowActionsByType(WorkflowActionType type, WorkflowModel workflow)` Returns workflow actions by type
`WorkflowActionModel`	`idle(WorkflowActionModel action)` Idles action
`boolean`	`isActive(WorkflowActionModel action)` Returns true if action is active
`boolean`	`isCompleted(WorkflowActionModel action)` Returns true if action is completed
`boolean`	`isDisabled(WorkflowActionModel action)` Returns true if action is disabled
`boolean`	`isEndedByWorkflow(WorkflowActionModel action)` Returns true if action is ended by a workdlow
`boolean`	`isUserAssignedPrincipal(WorkflowActionModel action)` Returns true if user is assigned to action

- Method Detail
  - getNormalWorkflowActions
```
java.util.List<WorkflowActionModel> getNormalWorkflowActions(WorkflowModel workflow)
```
    Returns normal workflow actions
    
    Parameters:
    
    workflow - to which actions belongs to
  - getStartWorkflowActions
```
java.util.List<WorkflowActionModel> getStartWorkflowActions(WorkflowModel workflow)
```
    Returns start workflow actions
    
    Parameters:
    
    workflow - to which actions belongs to
  - getEndWorkflowActions
```
java.util.List<WorkflowActionModel> getEndWorkflowActions(WorkflowModel workflow)
```
    Returns ended workflow actions
    
    Parameters:
    
    workflow - to which actions belongs to
  - getWorkflowActionsByType
```
java.util.List<WorkflowActionModel> getWorkflowActionsByType(WorkflowActionType type,
                                                             WorkflowModel workflow)
```
    Returns workflow actions by type
    
    Parameters:
    
    workflow - to which actions belongs to
    
    type - action type
  - getAllUserWorkflowActionsWithAttachment
```
java.util.List<WorkflowActionModel> getAllUserWorkflowActionsWithAttachment(java.lang.String attachmentTypeCodeOrClassName)
```
    Returns workflow actions with attachment that match type or code passed as a parameter
    
    Parameters:
    
    attachmentTypeCodeOrClassName - attachment typecode or class name
  - getAllUserWorkflowActionsWithAttachment
```
java.util.List<WorkflowActionModel> getAllUserWorkflowActionsWithAttachment(ComposedTypeModel attachmentType)
```
    Returns workflow actions with attachment that match type passed as a parameter
    
    Parameters:
    
    attachmentType - attachment type
  - getAllUserWorkflowActionsWithAttachments
```
java.util.List<WorkflowActionModel> getAllUserWorkflowActionsWithAttachments(java.util.List<java.lang.String> attachments)
```
    Returns workflow actions with attachment that match types passed
    
    Parameters:
    
    attachments - attachment types
  - getAllUserWorkflowActionsWithAttachments
```
java.util.List<WorkflowActionModel> getAllUserWorkflowActionsWithAttachments(java.util.List<java.lang.String> attachments,
                                                                             java.util.Collection<WorkflowActionStatus> actionStatuses)
```
    Returns workflow actions with attachment that match types passed and statuses
    
    Parameters:
    
    attachments - attachment types
    
    actionStatuses - statuses that must match
  - createWorkflowAction
```
WorkflowActionModel createWorkflowAction(WorkflowActionTemplateModel template,
                                         WorkflowModel workflow)
```
    Creates workflow action based on template and attach it to workflow
    
    Parameters:
    
    template - action template
    
    workflow - to which action will be attached to
    
    Returns:
    
    created action
  - isUserAssignedPrincipal
```
boolean isUserAssignedPrincipal(WorkflowActionModel action)
```
    Returns true if user is assigned to action
    
    Parameters:
    
    action -
    
    Returns:
    
    true if user is assigned to action, false otherwise
  - isCompleted
```
boolean isCompleted(WorkflowActionModel action)
```
    Returns true if action is completed
    
    Parameters:
    
    action - to be checked
  - isActive
```
boolean isActive(WorkflowActionModel action)
```
    Returns true if action is active
    
    Parameters:
    
    action - to be checked
  - isEndedByWorkflow
```
boolean isEndedByWorkflow(WorkflowActionModel action)
```
    Returns true if action is ended by a workdlow
    
    Parameters:
    
    action - to be checked
  - isDisabled
```
boolean isDisabled(WorkflowActionModel action)
```
    Returns true if action is disabled
    
    Parameters:
    
    action - to be checked
  - disable
```
WorkflowActionModel disable(WorkflowActionModel action)
```
    Disable action
    
    Parameters:
    
    action - to be disabled
  - complete
```
WorkflowActionModel complete(WorkflowActionModel action)
```
    Completes action
    
    Parameters:
    
    action - to be completed
  - idle
```
WorkflowActionModel idle(WorkflowActionModel action)
```
    Idles action
    
    Parameters:
    
    action - to be idled
  - getActionForCode
```
WorkflowActionModel getActionForCode(WorkflowModel workflow,
                                     java.lang.String code)
```

Interface WorkflowActionService

Method Summary

Method Detail

getNormalWorkflowActions

getStartWorkflowActions

getEndWorkflowActions

getWorkflowActionsByType

getAllUserWorkflowActionsWithAttachment

getAllUserWorkflowActionsWithAttachment

getAllUserWorkflowActionsWithAttachments

getAllUserWorkflowActionsWithAttachments

createWorkflowAction

isUserAssignedPrincipal

isCompleted

isActive

isEndedByWorkflow

isDisabled

disable

complete

idle

getActionForCode