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

Enum Class RetentionBasis

java.lang.Object

java.lang.Enum<RetentionBasis>

org.odpi.openmetadata.frameworks.openmetadata.enums.RetentionBasis

All Implemented Interfaces:

Serializable, Comparable<RetentionBasis>, Constable, OpenMetadataEnum

public enum RetentionBasis
extends Enum<RetentionBasis>
implements OpenMetadataEnum

RetentionBasis defines the retention requirements associated with a data item.

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
CONTRACT_LIFETIME	The data is needed for the lifetime of the referenced contract.
OTHER	Another basis for determining the retention requirement.
PROJECT_LIFETIME	The data is needed for the lifetime of the referenced project.
REGULATED_LIFETIME	The retention period for the data is defined by the referenced regulation.
TEAM_LIFETIME	The data is needed for the lifetime of the referenced team.
TEMPORARY	This data is temporary.
TIMEBOXED_LIFETIME	The data is needed for the specified time.
UNCLASSIFIED	There is no assessment of the retention requirements for this data.

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 RetentionBasis	valueOf(String name)	Returns the enum constant of this class with the specified name.
static RetentionBasis[]	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

UNCLASSIFIED

public static final RetentionBasis UNCLASSIFIED

There is no assessment of the retention requirements for this data.

TEMPORARY

public static final RetentionBasis TEMPORARY

This data is temporary. There are no formal retention requirements.

PROJECT_LIFETIME

public static final RetentionBasis PROJECT_LIFETIME

The data is needed for the lifetime of the referenced project.

TEAM_LIFETIME

public static final RetentionBasis TEAM_LIFETIME

The data is needed for the lifetime of the referenced team.

CONTRACT_LIFETIME

public static final RetentionBasis CONTRACT_LIFETIME

The data is needed for the lifetime of the referenced contract.

REGULATED_LIFETIME

public static final RetentionBasis REGULATED_LIFETIME

The retention period for the data is defined by the referenced regulation.

TIMEBOXED_LIFETIME

public static final RetentionBasis TIMEBOXED_LIFETIME

The data is needed for the specified time.

OTHER

public static final RetentionBasis OTHER

Another basis for determining the retention requirement.

Method Details

values

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

Returns:

print out of variables in a JSON-style