Package org.odpi.openmetadata.frameworks.governanceaction.properties

Enum Class CompletionStatus

java.lang.Object
java.lang.Enum<CompletionStatus>
org.odpi.openmetadata.frameworks.governanceaction.properties.CompletionStatus
All Implemented Interfaces:
Serializable, Comparable<CompletionStatus>, Constable
public enum CompletionStatus extends Enum<CompletionStatus>
CompletionStatus defines the completion status of a governance action service.

  • Nested Class Summary

    Nested classes/interfaces inherited from class java.lang.Enum

    Enum.EnumDesc<E extends Enum<E>>

  • Enum Constant Summary

    Enum Constants
    Enum Constant
    Description
    ACTIONED
    The governance action service for the governance action has successfully completed processing.
    FAILED
    The governance action service failed to execute the requested action.
    INVALID
    The governance action service has not performed the requested action because it is not appropriate (for example, a false positive).
    OTHER
    Undefined or unknown completion status.

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getDescription()
    Return the default description for the status for this enum instance.
    String
    getName()
    Return the default name for the status for this enum instance.
    String
    getOpenTypeGUID()
    Return the unique identifier for the open metadata enum type that this enum class represents.
    String
    getOpenTypeName()
    Return the unique name for the open metadata enum type that this enum class represents.
    int
    getOpenTypeOrdinal()
    Return the code for this enum that comes from the Open Metadata Type that this enum represents.
    int
    getOrdinal()
    Return the status code for this enum instance
    String
    toString()
    Standard toString method.
    static CompletionStatus
    valueOf(String name)
    Returns the enum constant of this class with the specified name.
    static CompletionStatus[]
    values()
    Returns an array containing the constants of this enum class, in the order they are declared.

    Methods inherited from class java.lang.Enum

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

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait

  • Enum Constant Details

    • ACTIONED

      public static final CompletionStatus ACTIONED
      The governance action service for the governance action has successfully completed processing.

    • INVALID

      public static final CompletionStatus INVALID
      The governance action service has not performed the requested action because it is not appropriate (for example, a false positive).

    • FAILED

      public static final CompletionStatus FAILED
      The governance action service failed to execute the requested action.

    • OTHER

      public static final CompletionStatus OTHER
      Undefined or unknown completion status.

  • Method Details

    • values

      public static CompletionStatus[] 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 CompletionStatus 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

    • getOrdinal

      public int getOrdinal()
      Return the status code for this enum instance
      Returns:
      int status code

    • getName

      public String getName()
      Return the default name for the status for this enum instance.
      Returns:
      String default status name

    • getDescription

      public String getDescription()
      Return the default description for the status for this enum instance.
      Returns:
      String default status description

    • getOpenTypeOrdinal

      public int getOpenTypeOrdinal()
      Return the code for this enum that comes from the Open Metadata Type that this enum represents.
      Returns:
      int code number

    • getOpenTypeGUID

      public String getOpenTypeGUID()
      Return the unique identifier for the open metadata enum type that this enum class represents.
      Returns:
      string guid

    • getOpenTypeName

      public String getOpenTypeName()
      Return the unique name for the open metadata enum type that this enum class represents.
      Returns:
      string name

    • toString

      public String toString()
      Standard toString method.
      Overrides:
      toString in class Enum<CompletionStatus>
      Returns:
      print out of variables in a JSON-style