Package org.alfresco.rest.rm.community.model.recordcategory

Enum Class RetentionPeriodProperty

java.lang.Object

java.lang.Enum<RetentionPeriodProperty>

org.alfresco.rest.rm.community.model.recordcategory.RetentionPeriodProperty

All Implemented Interfaces:

Serializable, Comparable<RetentionPeriodProperty>, Constable

public enum RetentionPeriodProperty
extends Enum<RetentionPeriodProperty>

The property of the dispositioned item that is used to calculate the "as of" period.

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
CREATED_DATE	Item created date.
CUT_OFF_DATE	Item cut off date.
DATE_FILED	Record filed date.

Method Summary

Modifier and Type	Method	Description
String	getPeriodProperty()
static RetentionPeriodProperty	valueOf(String name)	Returns the enum constant of this class with the specified name.
static RetentionPeriodProperty[]	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, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

CREATED_DATE

public static final RetentionPeriodProperty CREATED_DATE

Item created date.

DATE_FILED

public static final RetentionPeriodProperty DATE_FILED

Record filed date.

CUT_OFF_DATE

public static final RetentionPeriodProperty CUT_OFF_DATE

Item cut off date.

Method Details

values

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

getPeriodProperty

public String getPeriodProperty()