org.odpi.openmetadata.metadatasecurity.properties

Enum ReferenceableStatus

java.lang.Object

java.lang.Enum<ReferenceableStatus>

org.odpi.openmetadata.metadatasecurity.properties.ReferenceableStatus

All Implemented Interfaces:

Serializable, Comparable<ReferenceableStatus>

public enum ReferenceableStatus
extends Enum<ReferenceableStatus>
implements Serializable

The ReferenceableStatus enum defines the status of an instance (classification, relationship or an entity) in the metadata collection. 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.
• Rejected: The request or proposal is rejected.
• Approved concept: The request or proposal is approved for development.
• Under development: The instance is being developed.
• Development complete: The development of the instance is complete.
• Approved for deployment: The instance is approved for deployment.
• StandBy: The instance is deployed in standby mode.
• Active: The instance is approved and in use.
• Failed: The instance is not in use due to failure.
• Disabled: The instance is shutdown or disabled.
• Complete: The activity associated with the instance is complete.
• Deprecated: The instance is out of date and should not be used.
• Other: The instance is in a locally defined state.
• 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
APPROVED
APPROVED_CONCEPT
APPROVED_FOR_DEPLOYMENT
COMPLETE
DELETED
DEPRECATED
DEVELOPMENT_COMPLETE
DISABLED
DRAFT
FAILED
OTHER
PREPARED
PROPOSED
REJECTED
STANDBY
UNDER_DEVELOPMENT
UNKNOWN

Method Summary

Modifier and Type	Method and Description
String	getDescription() Return the description for the enum.
String	getName() Return the descriptive name for the enum.
int	getOMRSOrdinal() Return the ordinal for the equivalent OMRS status.
int	getOrdinal() Return the numerical value for the enum.
String	toString() toString() JSON-style
static ReferenceableStatus	valueOf(String name) Returns the enum constant of this type with the specified name.
static ReferenceableStatus[]	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, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

UNKNOWN

public static final ReferenceableStatus UNKNOWN

DRAFT

public static final ReferenceableStatus DRAFT

PREPARED

public static final ReferenceableStatus PREPARED

PROPOSED

public static final ReferenceableStatus PROPOSED

APPROVED

public static final ReferenceableStatus APPROVED

REJECTED

public static final ReferenceableStatus REJECTED

APPROVED_CONCEPT

public static final ReferenceableStatus APPROVED_CONCEPT

UNDER_DEVELOPMENT

public static final ReferenceableStatus UNDER_DEVELOPMENT

DEVELOPMENT_COMPLETE

public static final ReferenceableStatus DEVELOPMENT_COMPLETE

APPROVED_FOR_DEPLOYMENT

public static final ReferenceableStatus APPROVED_FOR_DEPLOYMENT

STANDBY

public static final ReferenceableStatus STANDBY

ACTIVE

public static final ReferenceableStatus ACTIVE

FAILED

public static final ReferenceableStatus FAILED

DISABLED

public static final ReferenceableStatus DISABLED

COMPLETE

public static final ReferenceableStatus COMPLETE

DEPRECATED

public static final ReferenceableStatus DEPRECATED

OTHER

public static final ReferenceableStatus OTHER

DELETED

public static final ReferenceableStatus DELETED

Method Detail

values

public static ReferenceableStatus[] 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 (ReferenceableStatus c : ReferenceableStatus.values())
    System.out.println(c);

Returns:

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

valueOf

public static ReferenceableStatus 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

getOMRSOrdinal

public int getOMRSOrdinal()

Return the ordinal for the equivalent OMRS status. This helps convert between an OMRS entity and the security bean.

Returns:

int enum value ordinal from OMRS

getName

public String getName()

Return the descriptive name for the enum.

Returns:

String name

getDescription

public String getDescription()

Return the description for the enum.

Returns:

String description

toString

public String toString()

toString() JSON-style

Overrides:

toString in class Enum<ReferenceableStatus>

Returns:

string description