org.odpi.openmetadata.frameworks.connectors.properties.beans

Enum RetentionBasis

java.lang.Object

java.lang.Enum<RetentionBasis>

org.odpi.openmetadata.frameworks.connectors.properties.beans.RetentionBasis

All Implemented Interfaces:

Serializable, Comparable<RetentionBasis>

public enum RetentionBasis
extends Enum<RetentionBasis>
implements Serializable

RetentionBasis defines the retention requirements associated with a data item.

Enum Constant Summary

Enum Constants

Enum Constant and Description
CONTRACT_LIFETIME
OTHER
PROJECT_LIFETIME
REGULATED_LIFETIME
TEAM_LIFETIME
TEMPORARY
TIMEBOXED_LIFETIME
UNCLASSIFIED

Field Summary

Fields

Modifier and Type	Field and Description
static String	ENUM_TYPE_GUID
static String	ENUM_TYPE_NAME

Method Summary

Modifier and Type	Method and Description
String	getDescription() Return the default description for this enum.
String	getName() Return the default name for this enum type.
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 used for indexing based on the enum value.
String	toString() Standard toString method.
static RetentionBasis	valueOf(String name) Returns the enum constant of this type with the specified name.
static RetentionBasis[]	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

UNCLASSIFIED

public static final RetentionBasis UNCLASSIFIED

TEMPORARY

public static final RetentionBasis TEMPORARY

PROJECT_LIFETIME

public static final RetentionBasis PROJECT_LIFETIME

TEAM_LIFETIME

public static final RetentionBasis TEAM_LIFETIME

CONTRACT_LIFETIME

public static final RetentionBasis CONTRACT_LIFETIME

REGULATED_LIFETIME

public static final RetentionBasis REGULATED_LIFETIME

TIMEBOXED_LIFETIME

public static final RetentionBasis TIMEBOXED_LIFETIME

OTHER

public static final RetentionBasis OTHER

Field Detail

ENUM_TYPE_GUID

public static final String ENUM_TYPE_GUID

See Also:

Constant Field Values

ENUM_TYPE_NAME

public static final String ENUM_TYPE_NAME

See Also:

Constant Field Values

Method Detail

values

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

Returns:

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

valueOf

public static RetentionBasis 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 code for this enum used for indexing based on the enum value.

Returns:

int code number

getName

public String getName()

Return the default name for this enum type.

Returns:

String name

getDescription

public String getDescription()

Return the default description for this enum.

Returns:

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

Returns:

print out of variables in a JSON-style