Package de.hybris.platform.workflow

Interface WorkflowActionService

All Known Subinterfaces:
CMSWorkflowActionService
All Known Implementing Classes:
DefaultCMSWorkflowActionService, 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 Details

    • getNormalWorkflowActions

      List<WorkflowActionModel> getNormalWorkflowActions(WorkflowModel workflow)
      Returns normal workflow actions
      Parameters:
      workflow - to which actions belongs to

    • getStartWorkflowActions

      List<WorkflowActionModel> getStartWorkflowActions(WorkflowModel workflow)
      Returns start workflow actions
      Parameters:
      workflow - to which actions belongs to

    • getEndWorkflowActions

      List<WorkflowActionModel> getEndWorkflowActions(WorkflowModel workflow)
      Returns ended workflow actions
      Parameters:
      workflow - to which actions belongs to

    • getWorkflowActionsByType

      List<WorkflowActionModel> getWorkflowActionsByType(WorkflowActionType type, WorkflowModel workflow)
      Returns workflow actions by type
      Parameters:
      workflow - to which actions belongs to
      type - action type

    • getAllUserWorkflowActionsWithAttachment

      List<WorkflowActionModel> getAllUserWorkflowActionsWithAttachment(String attachmentTypeCodeOrClassName)
      Returns workflow actions with attachment that match type or code passed as a parameter
      Parameters:
      attachmentTypeCodeOrClassName - attachment typecode or class name

    • getAllUserWorkflowActionsWithAttachment

      List<WorkflowActionModel> getAllUserWorkflowActionsWithAttachment(ComposedTypeModel attachmentType)
      Returns workflow actions with attachment that match type passed as a parameter
      Parameters:
      attachmentType - attachment type

    • getAllUserWorkflowActionsWithAttachments

      List<WorkflowActionModel> getAllUserWorkflowActionsWithAttachments(List<String> attachments)
      Returns workflow actions with attachment that match types passed
      Parameters:
      attachments - attachment types

    • getAllUserWorkflowActionsWithAttachments

      List<WorkflowActionModel> getAllUserWorkflowActionsWithAttachments(List<String> attachments, 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, String code)