org.odpi.openmetadata.accessservices.subjectarea.properties.enums

Enum Status

java.lang.Object

java.lang.Enum<Status>

org.odpi.openmetadata.accessservices.subjectarea.properties.enums.Status

All Implemented Interfaces:

Serializable, Comparable<Status>

public enum Status
extends Enum<Status>
implements Serializable

The Status defines the status of a relationship or an entity in the glossary. It effectively defines its visibility to different types of queries. Most queries by default will only return instances in the active status.

• UNKNOWN Unknown status of instance.
• DRAFT The content is incomplete.
• PREPARED The content is ready for review.
• PROPOSED The content is in review.
• APPROVED Instance approved.
• ACTIVE: the instance is in active use.
• DELETED: the instance has been deleted and is waiting to be purged. It is kept in the metadata collection to support a restore request. It is not returned on normal queries.

Enum Constant Summary

Enum Constants

Enum Constant and Description
ACTIVE The instance is in use
APPROVED The content has been approved.
DELETED Instance that has been deleted and is no longer in use.
DRAFT The content incomplete and not ready for review.
PREPARED The content is ready for review.
PROPOSED The content is in review
UNKNOWN Unknown status of instance

Method Summary

Modifier and Type	Method and Description
int	getOrdinal() Return the numerical value for the enum.
String	getStatusDescription() Return the description for the enum.
String	getStatusName() Return the descriptive name for the enum.
static Status	valueOf(String name) Returns the enum constant of this type with the specified name.
static Status[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

UNKNOWN

public static final Status UNKNOWN

Unknown status of instance

DRAFT

public static final Status DRAFT

The content incomplete and not ready for review.

PREPARED

public static final Status PREPARED

The content is ready for review.

PROPOSED

public static final Status PROPOSED

The content is in review

APPROVED

public static final Status APPROVED

The content has been approved.

ACTIVE

public static final Status ACTIVE

The instance is in use

DELETED

public static final Status DELETED

Instance that has been deleted and is no longer in use.

Method Detail

values

public static Status[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (Status c : Status.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static Status valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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 type has no constant with the specified name

NullPointerException - if the argument is null

getOrdinal

public int getOrdinal()

Return the numerical value for the enum.

Returns:

int enum value ordinal

getStatusName

public String getStatusName()

Return the descriptive name for the enum.

Returns:

String name

getStatusDescription

public String getStatusDescription()

Return the description for the enum.

Returns:

String description