Package com.mendix.workflows

Enum WorkflowState

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<WorkflowState>
    public enum WorkflowState
extends java.lang.Enum<WorkflowState>
    Indicates the state of workflow.

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      ABORTED
      The state after the admin abort the workflow.
      COMPLETED
      The terminal state indicates that the workflow is finished.
      FAILED
      The state after a failure occurred during execution of the workflow.
      IN_PROGRESS
      Initial state.
      INCOMPATIBLE
      The state after introducing incompatible new version of the workflow with the current one or workflow definition is deleted.
      PAUSED
      The state after the admin pause the workflow.

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.String getValue()
      Returns the string representation of the workflow state.
      static WorkflowState valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static WorkflowState[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.

      • Methods inherited from class java.lang.Enum

        clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

      • Methods inherited from class java.lang.Object

        getClass, notify, notifyAll, wait, wait, wait

    • Enum Constant Detail

      • IN_PROGRESS

        public static final WorkflowState IN_PROGRESS
        Initial state.

      • COMPLETED

        public static final WorkflowState COMPLETED
        The terminal state indicates that the workflow is finished.

      • PAUSED

        public static final WorkflowState PAUSED
        The state after the admin pause the workflow. Unpausing brings it back to IN_PROGRESS.

      • ABORTED

        public static final WorkflowState ABORTED
        The state after the admin abort the workflow.

      • FAILED

        public static final WorkflowState FAILED
        The state after a failure occurred during execution of the workflow.

      • INCOMPATIBLE

        public static final WorkflowState INCOMPATIBLE
        The state after introducing incompatible new version of the workflow with the current one or workflow definition is deleted.

    • Method Detail

      • values

        public static WorkflowState[] values()
        Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows: 
        for (WorkflowState c : WorkflowState.values())
    System.out.println(c);
        Returns:
        an array containing the constants of this enum type, in the order they are declared

      • valueOf

        public static WorkflowState valueOf​(java.lang.String name)
        Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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:
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        java.lang.NullPointerException - if the argument is null

      • getValue

        public java.lang.String getValue()
        Returns the string representation of the workflow state.
        Returns:
        the string representation of the workflow state