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

Enum RetentionBasis

java.lang.Object

java.lang.Enum<RetentionBasis>

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

All Implemented Interfaces:

Serializable, Comparable<RetentionBasis>

public enum RetentionBasis
extends Enum<RetentionBasis>
implements Serializable

Defines the retention requirements associated with a data item.

Enum Constant Summary

Enum Constants

Enum Constant	Description
ContractLifetime	The data is needed for the lifetime of the referenced contract.
Other	Another basis for determining the retention requirement.
ProjectLifetime	The data is needed for the lifetime of the referenced project.
RegulatedLifetime	The retention period for the data is defined by the referenced regulation.
TeamLifetime	The data is needed for the lifetime of the referenced team.
Temporary	This data is temporary.
TimeBoxedLifetime	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 description for the enum.
String	getName()	Return the descriptive name for the RetentionBasis enum instance
int	getOrdinal()	Return the numerical value for the enum.
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, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

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.

ProjectLifetime

public static final RetentionBasis ProjectLifetime

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

TeamLifetime

public static final RetentionBasis TeamLifetime

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

ContractLifetime

public static final RetentionBasis ContractLifetime

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

RegulatedLifetime

public static final RetentionBasis RegulatedLifetime

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

TimeBoxedLifetime

public static final RetentionBasis TimeBoxedLifetime

The data is needed for the specified time.

Other

public static final RetentionBasis Other

Another basis for determining the retention requirement.

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 numerical value for the enum.

Returns:

int enum value ordinal

getDescription

public String getDescription()

Return the description for the enum.

Returns:

String description

getName

public String getName()

Return the descriptive name for the RetentionBasis enum instance

Returns:

String name