com.box.sdk

Enum RetentionPolicyParams.RetentionType

Object

Enum<RetentionPolicyParams.RetentionType>

RetentionPolicyParams.RetentionType

All Implemented Interfaces:

Serializable, Comparable<RetentionPolicyParams.RetentionType>

Enclosing class:

RetentionPolicyParams

public static enum RetentionPolicyParams.RetentionType
extends Enum<RetentionPolicyParams.RetentionType>

The type of retention.

Enum Constant Summary

Enum Constants

Enum Constant and Description
MODIFIABLE You can modify the retention policy.
NON_MODIFIABLE You can modify the retention policy only in a limited way: add a folder, lengthen the duration, retire the policy, change the disposition action or notification settings.

Method Summary

Modifier and Type	Method and Description
static RetentionPolicyParams.RetentionType	valueOf(String name) Returns the enum constant of this type with the specified name.
static RetentionPolicyParams.RetentionType[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

MODIFIABLE

public static final RetentionPolicyParams.RetentionType MODIFIABLE

You can modify the retention policy. For example, you can add or remove folders, shorten or lengthen the policy duration, or delete the assignment. Use this type if your retention policy is not related to any regulatory purposes.

NON_MODIFIABLE

public static final RetentionPolicyParams.RetentionType NON_MODIFIABLE

You can modify the retention policy only in a limited way: add a folder, lengthen the duration, retire the policy, change the disposition action or notification settings. You cannot perform other actions, such as deleting the assignment or shortening the policy duration. Use this type to ensure compliance with regulatory retention policies.

Method Detail

values

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

Returns:

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

valueOf

public static RetentionPolicyParams.RetentionType 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