Package org.odpi.openmetadata.frameworks.openmetadata.enums

Enum Class CollectionMemberStatus

java.lang.Object
java.lang.Enum<CollectionMemberStatus>
org.odpi.openmetadata.frameworks.openmetadata.enums.CollectionMemberStatus
All Implemented Interfaces:
Serializable, Comparable<CollectionMemberStatus>, Constable, OpenMetadataEnum
public enum CollectionMemberStatus extends Enum<CollectionMemberStatus> implements OpenMetadataEnum
CollectionMemberStatus specifies the status of the member in a collection.

  • Enum Constant Details

    • UNKNOWN

      public static final CollectionMemberStatus UNKNOWN
      The status of the member is not known or not specified. This is the default value.

    • DISCOVERED

      public static final CollectionMemberStatus DISCOVERED
      The member was added by an automated process.

    • PROPOSED

      public static final CollectionMemberStatus PROPOSED
      The member was proposed by a consumer.

    • IMPORTED

      public static final CollectionMemberStatus IMPORTED
      The member was imported from another system.

    • VALIDATED

      public static final CollectionMemberStatus VALIDATED
      The member has been validated by a custodian/steward/approver and can be trusted.

    • DEPRECATED

      public static final CollectionMemberStatus DEPRECATED
      The membership has been deprecated. Consider stopping using it.

    • OBSOLETE

      public static final CollectionMemberStatus OBSOLETE
      The membership is obsolete and should not be used.

    • OTHER

      public static final CollectionMemberStatus OTHER
      The membership has a different status not covered by the open metadata types.

  • Method Details

    • values

      public static CollectionMemberStatus[] 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 CollectionMemberStatus 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 numeric representation of the enumeration.
      Specified by:
      getOrdinal in interface OpenMetadataEnum
      Returns:
      int ordinal

    • getName

      public String getName()
      Return the default name of the enumeration.
      Specified by:
      getName in interface OpenMetadataEnum
      Returns:
      String name

    • getDescription

      public String getDescription()
      Return the default description of the enumeration.
      Specified by:
      getDescription in interface OpenMetadataEnum
      Returns:
      String description

    • getDescriptionGUID

      public String getDescriptionGUID()
      Return the unique identifier for the valid value that represents the enum value.
      Specified by:
      getDescriptionGUID in interface OpenMetadataEnum
      Returns:
      guid

    • isDefault

      public boolean isDefault()
      Return whether the enum is the default value or not.
      Specified by:
      isDefault in interface OpenMetadataEnum
      Returns:
      boolean

    • getOpenTypeGUID

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

    • getOpenTypeName

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

    • getOpenTypeDescription

      public static String getOpenTypeDescription()
      Return the description for the open metadata enum type that this enum class represents.
      Returns:
      string description

    • getOpenTypeDescriptionGUID

      public static String getOpenTypeDescriptionGUID()
      Return the unique identifier for the valid value element for the open metadata enum type that this enum class represents.
      Returns:
      string guid

    • getOpenTypeDescriptionWiki

      public static String getOpenTypeDescriptionWiki()
      Return the unique identifier for the valid value element for the open metadata enum type that this enum class represents.
      Returns:
      string guid

    • getQualifiedName

      public String getQualifiedName()
      Return the qualified name for this value.
      Returns:
      string

    • getCategory

      public String getCategory()
      Return the category for this value.
      Returns:
      string

    • toString

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