Package de.xima.fc.mdl.fdv

Enum EProcessingResult

  • All Implemented Interfaces:
    Serializable, Comparable<EProcessingResult>
    public enum EProcessingResult
extends Enum<EProcessingResult>
    Enumeration for the types of data provided by the workflow. Used for different placeholder types, such as [%MyAction.RESULT%] or [%MyAction.LAST_ERROR_NODE_NAME%].
    Author:
    XIMA MEDIA GmbH

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      ALWAYS
      (new workflow engine only) The value that is always returned by a node, whether successful or not.
      COUNT
      Deprecated.
      You can use the length() as part of the JSON path to find the size of an array.
      CURRENT
      (new workflow engine only) The value that is made available by a node while it is being executed (e.g.
      ERROR
      (new workflow engine only) The value that is returned by a node when it failed.
      ERROR_CODE
      (new workflow engine only) The type of error that caused a node to fail.
      ERROR_MESSAGE
      (new workflow engine only) The error message provided by a node when it failed.
      ERROR_NODE_NAME
      (new workflow engine only) The name of the node that failed.
      ERROR_NODE_TYPE
      (new workflow engine only) The technical node type of the node that failed.
      HAS_HARD_ERROR
      (new workflow engine only) A boolean flag indicating whether an action completed abruptly by throwing an exception.
      HAS_SOFT_ERROR
      (new workflow engine only) A boolean flag indicating whether an action completed normally or abruptly by issuing a returning statement; and provided at least one soft error.
      RESULT
      (both workflow engines) The value that is returned by a node when it succeeded.
      SOFT_ERRORS
      (new workflow engine only) A list of soft errors provided by an action that either completed normally or abruptly by issuing a returning statement.
      SUCCESS
      (both workflow engines) A boolean flag indicating whether an action was successful.

    • Enum Constant Detail

      • ALWAYS

        public static final EProcessingResult ALWAYS
        (new workflow engine only) The value that is always returned by a node, whether successful or not.
        Since:
        7.0.0

      • CURRENT

        public static final EProcessingResult CURRENT
        (new workflow engine only) The value that is made available by a node while it is being executed (e.g. the iteration status for loops).
        Since:
        8.0.0

      • ERROR

        public static final EProcessingResult ERROR
        (new workflow engine only) The value that is returned by a node when it failed.
        Since:
        7.0.0

      • RESULT

        public static final EProcessingResult RESULT
        (both workflow engines) The value that is returned by a node when it succeeded.

      • COUNT

        public static final EProcessingResult COUNT
        Deprecated.
        You can use the length() as part of the JSON path to find the size of an array. For example, the SQL statement actions returns a JSON object with a rows array, use [%SQLAction.RESULT.rows.length()%] to get the number of results. (old workflow engine only)
        The number of results returned by a node.

      • SUCCESS

        public static final EProcessingResult SUCCESS
        (both workflow engines) A boolean flag indicating whether an action was successful.

      • HAS_HARD_ERROR

        public static final EProcessingResult HAS_HARD_ERROR
        (new workflow engine only) A boolean flag indicating whether an action completed abruptly by throwing an exception.

      • HAS_SOFT_ERROR

        public static final EProcessingResult HAS_SOFT_ERROR
        (new workflow engine only) A boolean flag indicating whether an action completed normally or abruptly by issuing a returning statement; and provided at least one soft error.

      • SOFT_ERRORS

        public static final EProcessingResult SOFT_ERRORS
        (new workflow engine only) A list of soft errors provided by an action that either completed normally or abruptly by issuing a returning statement.

      • ERROR_CODE

        public static final EProcessingResult ERROR_CODE
        (new workflow engine only) The type of error that caused a node to fail.
        Since:
        7.0.0

      • ERROR_MESSAGE

        public static final EProcessingResult ERROR_MESSAGE
        (new workflow engine only) The error message provided by a node when it failed.
        Since:
        7.0.0

      • ERROR_NODE_NAME

        public static final EProcessingResult ERROR_NODE_NAME
        (new workflow engine only) The name of the node that failed.
        Since:
        7.0.0

      • ERROR_NODE_TYPE

        public static final EProcessingResult ERROR_NODE_TYPE
        (new workflow engine only) The technical node type of the node that failed.
        Since:
        7.0.0

    • Method Detail

      • values

        public static EProcessingResult[] 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 (EProcessingResult c : EProcessingResult.values())
    System.out.println(c);
        Returns:
        an array containing the constants of this enum type, in the order they are declared

      • valueOf

        public static EProcessingResult valueOf​(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:
        IllegalArgumentException - if this enum type has no constant with the specified name
        NullPointerException - if the argument is null

      • valueOfOrDefault

        public static EProcessingResult valueOfOrDefault​(String name,
                                                 EProcessingResult defaultValue)
        Parameters:
        name - Name to convert.
        defaultValue - Value to use as a fallback.
        Returns:
        The enumeration constant with the given name, or the default value when no such constant exists.