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

Enum Class GlossaryTermRelationshipStatus

java.lang.Object

java.lang.Enum<GlossaryTermRelationshipStatus>

org.odpi.openmetadata.accessservices.assetmanager.properties.GlossaryTermRelationshipStatus

All Implemented Interfaces:

Serializable, Comparable<GlossaryTermRelationshipStatus>, Constable

public enum GlossaryTermRelationshipStatus
extends Enum<GlossaryTermRelationshipStatus>

A GlossaryTermRelationshipStatus defines the status of a relationship with a glossary term.

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 relationship is approved and in use.
DEPRECATED	Deprecated - The term relationship should no longer be used.
DRAFT	Draft - The term relationship is in development.
OBSOLETE	Obsolete - The term relationship must no longer be used.
OTHER	Other - Another term relationship status.

Method Summary

Modifier and Type	Method	Description
String	getDescription()	Return the default description for the key pattern for this enum instance.
String	getName()	Return the default name 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 code for this enum instance
String	toString()	Standard toString method.
static GlossaryTermRelationshipStatus	valueOf(String name)	Returns the enum constant of this class with the specified name.
static GlossaryTermRelationshipStatus[]	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 GlossaryTermRelationshipStatus DRAFT

Draft - The term relationship is in development.

ACTIVE

public static final GlossaryTermRelationshipStatus ACTIVE

Active - The term relationship is approved and in use.

DEPRECATED

public static final GlossaryTermRelationshipStatus DEPRECATED

Deprecated - The term relationship should no longer be used.

OBSOLETE

public static final GlossaryTermRelationshipStatus OBSOLETE

Obsolete - The term relationship must no longer be used.

OTHER

public static final GlossaryTermRelationshipStatus OTHER

Other - Another term relationship status.

Method Details

values

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

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

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<GlossaryTermRelationshipStatus>

Returns:

print out of variables in a JSON-style