Package org.odpi.openmetadata.accessservices.assetmanager.properties

Enum Class GlossaryTermStatus

java.lang.Object
java.lang.Enum<GlossaryTermStatus>
org.odpi.openmetadata.accessservices.assetmanager.properties.GlossaryTermStatus
All Implemented Interfaces:
Serializable, Comparable<GlossaryTermStatus>, Constable
public enum GlossaryTermStatus extends Enum<GlossaryTermStatus>
The GlossaryTermStatus defines the status of a glossary term. It effectively defines its visibility to different types of queries. Most queries by default will only return instances in the active status.
  • Unknown: Unknown instance status.
  • Draft: The content is incomplete.
  • Proposed: The content is in review.
  • Approved: The content is approved.
  • Active: The instance is approved and in use.

  • Enum Constant Details

    • DRAFT

      public static final GlossaryTermStatus DRAFT
      Draft - The term is incomplete.

    • PREPARED

      public static final GlossaryTermStatus PREPARED
      Prepared - The term is ready for review.

    • PROPOSED

      public static final GlossaryTermStatus PROPOSED
      Proposed - The term is in review.

    • APPROVED

      public static final GlossaryTermStatus APPROVED
      Approved - The term is approved and ready to be activated.

    • REJECTED

      public static final GlossaryTermStatus REJECTED
      Rejected - The term is rejected and should not be used.

    • ACTIVE

      public static final GlossaryTermStatus ACTIVE
      Active - The term is approved and in use.

    • DEPRECATED

      public static final GlossaryTermStatus DEPRECATED
      Deprecated - The term is out of date and should not be used.

    • OTHER

      public static final GlossaryTermStatus OTHER
      Other - The term is in a locally defined state.

  • Method Details

    • values

      public static GlossaryTermStatus[] 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 GlossaryTermStatus 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 code for this enum instance
      Returns:
      int key pattern code

    • 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

    • getName

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

    • getDescription

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

    • toString

      public String toString()
      toString() JSON-style
      Overrides:
      toString in class Enum<GlossaryTermStatus>
      Returns:
      string description