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

Enum Class AnnotationStatus

java.lang.Object

java.lang.Enum<AnnotationStatus>

org.odpi.openmetadata.frameworks.openmetadata.enums.AnnotationStatus

All Implemented Interfaces:

Serializable, Comparable<AnnotationStatus>, Constable, OpenMetadataEnum

public enum AnnotationStatus
extends Enum<AnnotationStatus>
implements OpenMetadataEnum

An AnnotationStatus defines the current status for an annotation plus some default descriptive text.

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_ANNOTATION	Annotation has been approved and insight has been added to Asset's metadata.
APPROVED_ANNOTATION	Annotation has been approved.
IGNORE_ANNOTATION	Annotation is invalid and should be ignored.
INVALID_ANNOTATION	Annotation has been reviewed and declared invalid.
NEW_ANNOTATION	Annotation has been created but not reviewed.
OTHER_STATUS	Annotation's status stored in additional properties
REVIEWED_ANNOTATION	Annotation has been reviewed by no decision has been made.
UNKNOWN_STATUS	Annotation has not had a status assigned

Method Summary

Modifier and Type	Method	Description
String	getDescription()	Return the default description of the enumeration.
String	getDescriptionGUID()	Return the unique identifier for the valid value that represents the enum value.
String	getName()	Return the default name of the enumeration.
static String	getOpenTypeDescription()	Return the description for the open metadata enum type that this enum class represents.
static String	getOpenTypeDescriptionGUID()	Return the unique identifier for the valid value element for the open metadata enum type that this enum class represents.
static String	getOpenTypeDescriptionWiki()	Return the unique identifier for the valid value element for the open metadata enum type that this enum class represents.
static String	getOpenTypeGUID()	Return the unique identifier for the open metadata enum type that this enum class represents.
static String	getOpenTypeName()	Return the unique name for the open metadata enum type that this enum class represents.
int	getOrdinal()	Return the numeric representation of the enumeration.
boolean	isDefault()	Return whether the enum is the default value or not.
String	toString()	Standard toString method.
static AnnotationStatus	valueOf(String name)	Returns the enum constant of this class with the specified name.
static AnnotationStatus[]	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

NEW_ANNOTATION

public static final AnnotationStatus NEW_ANNOTATION

Annotation has been created but not reviewed.

REVIEWED_ANNOTATION

public static final AnnotationStatus REVIEWED_ANNOTATION

Annotation has been reviewed by no decision has been made.

APPROVED_ANNOTATION

public static final AnnotationStatus APPROVED_ANNOTATION

Annotation has been approved.

ACTIONED_ANNOTATION

public static final AnnotationStatus ACTIONED_ANNOTATION

Annotation has been approved and insight has been added to Asset's metadata.

INVALID_ANNOTATION

public static final AnnotationStatus INVALID_ANNOTATION

Annotation has been reviewed and declared invalid.

IGNORE_ANNOTATION

public static final AnnotationStatus IGNORE_ANNOTATION

Annotation is invalid and should be ignored.

OTHER_STATUS

public static final AnnotationStatus OTHER_STATUS

Annotation's status stored in additional properties

UNKNOWN_STATUS

public static final AnnotationStatus UNKNOWN_STATUS

Annotation has not had a status assigned

Method Details

values

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

toString

public String toString()

Standard toString method.

Overrides:

toString in class Enum<AnnotationStatus>

Returns:

print out of variables in a JSON-style