Enum Class WorkflowStatus

java.lang.Object
java.lang.Enum<WorkflowStatus>
de.hybris.platform.workflow.WorkflowStatus
All Implemented Interfaces:
Serializable, Comparable<WorkflowStatus>, Constable

public enum WorkflowStatus extends Enum<WorkflowStatus>
Each WorkflowModel can exist in four states:
  • planned - workflow created, but not started yet Running
  • running - in progress
  • terminated - workflow was in progress but it has interrupted for some reason
  • finished - workflow is done

WorkflowStatus is interpreted as a counter part for a WorkflowService.isPlanned(WorkflowModel), WorkflowService.isRunning(WorkflowModel), WorkflowService.isFinished(WorkflowModel), WorkflowService.isTerminated(WorkflowModel) to check what is the current state of the WorkflowModel.

WorkflowStatus is used as additional criteria to fetch WorkflowModel for more than one strict status within WorkflowService.getAllAdhocWorkflows(EnumSet, java.util.Date, java.util.Date) and WorkflowService.getAllWorkflows(EnumSet, java.util.Date, java.util.Date).

  • Enum Constant Details

  • Method Details

    • values

      public static WorkflowStatus[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared
    • valueOf

      public static WorkflowStatus valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum class has no constant with the specified name
      NullPointerException - if the argument is null
    • getAll

      public static EnumSet<WorkflowStatus> getAll()