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

Enum Class GlossaryTermStatus

java.lang.Object

java.lang.Enum<GlossaryTermStatus>

org.odpi.openmetadata.frameworks.openmetadata.enums.GlossaryTermStatus

All Implemented Interfaces:

Serializable, Comparable<GlossaryTermStatus>, Constable, OpenMetadataEnum

public enum GlossaryTermStatus
extends Enum<GlossaryTermStatus>
implements OpenMetadataEnum

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.

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
ACTIVE	Active - The term is approved and in use.
APPROVED	Approved - The term is approved and ready to be activated.
DEPRECATED	Deprecated - The term is out of date and should not be used.
DRAFT	Draft - The term is incomplete.
OTHER	Other - The term is in a locally defined state.
PREPARED	Prepared - The term is ready for review.
PROPOSED	Proposed - The term is in review.
REJECTED	Rejected - The term is rejected and should not be used.

Method Summary

Modifier and Type	Method	Description
String	getDescription()	Return the default description for the key pattern for this enum instance.
String	getDescriptionGUID()	Return the unique identifier for the valid value that represents the enum value.
String	getName()	Return the default name for this enum instance.
int	getOpenTypeOrdinal()	Return the code for this enum that comes from the Open Metadata Type that this enum represents.
int	getOrdinal()	Return the code for this enum instance
boolean	isDefault()	Return whether the enum is the default value or not.
String	toString()	toString() JSON-style
static GlossaryTermStatus	valueOf(String name)	Returns the enum constant of this class with the specified name.
static GlossaryTermStatus[]	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

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

Specified by:

getOrdinal in interface OpenMetadataEnum

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.

Specified by:

getName in interface OpenMetadataEnum

Returns:

String default name

getDescription

public String getDescription()

Return the default description for the key pattern for this enum instance.

Specified by:

getDescription in interface OpenMetadataEnum

Returns:

String default 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

toString

public String toString()

toString() JSON-style

Overrides:

toString in class Enum<GlossaryTermStatus>

Returns:

string description