Package de.hybris.platform.workflow
Interface WorkflowActionService
-
- All Known Subinterfaces:
CMSWorkflowActionService
- All Known Implementing Classes:
DefaultCMSWorkflowActionService,DefaultWorkflowActionService
public interface WorkflowActionServiceService 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 Description WorkflowActionModelcomplete(WorkflowActionModel action)Completes actionWorkflowActionModelcreateWorkflowAction(WorkflowActionTemplateModel template, WorkflowModel workflow)Creates workflow action based on template and attach it to workflowWorkflowActionModeldisable(WorkflowActionModel action)Disable actionWorkflowActionModelgetActionForCode(WorkflowModel workflow, java.lang.String code)java.util.List<WorkflowActionModel>getAllUserWorkflowActionsWithAttachment(ComposedTypeModel attachmentType)Returns workflow actions with attachment that match type passed as a parameterjava.util.List<WorkflowActionModel>getAllUserWorkflowActionsWithAttachment(java.lang.String attachmentTypeCodeOrClassName)Returns workflow actions with attachment that match type or code passed as a parameterjava.util.List<WorkflowActionModel>getAllUserWorkflowActionsWithAttachments(java.util.List<java.lang.String> attachments)Returns workflow actions with attachment that match types passedjava.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 statusesjava.util.List<WorkflowActionModel>getEndWorkflowActions(WorkflowModel workflow)Returns ended workflow actionsjava.util.List<WorkflowActionModel>getNormalWorkflowActions(WorkflowModel workflow)Returns normal workflow actionsjava.util.List<WorkflowActionModel>getStartWorkflowActions(WorkflowModel workflow)Returns start workflow actionsjava.util.List<WorkflowActionModel>getWorkflowActionsByType(WorkflowActionType type, WorkflowModel workflow)Returns workflow actions by typeWorkflowActionModelidle(WorkflowActionModel action)Idles actionbooleanisActive(WorkflowActionModel action)Returns true if action is activebooleanisCompleted(WorkflowActionModel action)Returns true if action is completedbooleanisDisabled(WorkflowActionModel action)Returns true if action is disabledbooleanisEndedByWorkflow(WorkflowActionModel action)Returns true if action is ended by a workdlowbooleanisUserAssignedPrincipal(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 totype- 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 typesactionStatuses- 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 templateworkflow- 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)
-
-