Content Engine Java API: DeviceRetentionMode

java.lang.Object
- com.filenet.api.constants.DeviceRetentionMode

All Implemented Interfaces:

java.io.Serializable
```
public final class DeviceRetentionMode
extends java.lang.Object
implements java.io.Serializable
```
Specifies the retention mode of a fixed storage area relative to a fixed content device. Both modes apply only to checked-in documents that have their content stored on a fixed content device.

See Also:
Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`static DeviceRetentionMode`	`ALIGNED` Indicates an alignment relative to a fixed content device.
`static int`	`ALIGNED_AS_INT` An `int` value associated with the ALIGNED instance of this class.
`static DeviceRetentionMode`	`NOT_ALIGNED` Indicates no alignment relative to a fixed content device.
`static int`	`NOT_ALIGNED_AS_INT` An `int` value associated with the NOT_ALIGNED instance of this class.

Method Summary

Methods
Modifier and Type	Method and Description
`static DeviceRetentionMode`	`getInstanceFromInt(int value)` Returns an instance of this class using its associated integer value.
`int`	`getValue()` Returns the internal integer value associated with a specific instance of this class.
`java.lang.String`	`toString()` Returns a `String` representation of this enumeration instance.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - ALIGNED_AS_INT
```
public static final int ALIGNED_AS_INT
```
    An int value associated with the ALIGNED instance of this class. Consider using the static instances of this class instead of the associated int values. The int values risk binary incompatibility (but not source incompatibility) from release to release.
    
    See Also:
    Constant Field Values
  - ALIGNED
```
public static final DeviceRetentionMode ALIGNED
```
    Indicates an alignment relative to a fixed content device. Documents checked in on a fixed storage area in aligned mode have retention enforced by both the Content Engine server and the fixed content device. In this mode, the fixed content device must support the retention period specified by the value of the CmRetentionDate property of the document, or else the operation fails. If the source location of the content data of a document is on a fixed content device that is under aligned mode, the content data can only be deleted or moved if the retention period of the document has expired.
  - NOT_ALIGNED_AS_INT
```
public static final int NOT_ALIGNED_AS_INT
```
    An int value associated with the NOT_ALIGNED instance of this class. Consider using the static instances of this class instead of the associated int values. The int values risk binary incompatibility (but not source incompatibility) from release to release.
    
    See Also:
    Constant Field Values
  - NOT_ALIGNED
```
public static final DeviceRetentionMode NOT_ALIGNED
```
    Indicates no alignment relative to a fixed content device. In this mode, retention is enforced by the Content Engine server only.
- Method Detail
  - getValue
```
public int getValue()
```
    Returns the internal integer value associated with a specific instance of this class.
    
    Returns:
    The enumeration instance's ordinal value.
    See Also:
    getInstanceFromInt(int)
  - toString
```
public java.lang.String toString()
```
    Returns a String representation of this enumeration instance.
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    The enumeration instance's description.
  - getInstanceFromInt
```
public static DeviceRetentionMode getInstanceFromInt(int value)
```
    Returns an instance of this class using its associated integer value.
    
    Parameters:
    value - The integer value. (See the *_AS_INT fields.)
    
    Returns:
    The enumeration instance with the given ordinal value.
    
    Throws:
    
    EngineRuntimeException - If an enumeration instance with the given ordinal value does not exist.
    See Also:
    getValue()

Methods inherited from class java.lang.Object

ALIGNED_AS_INT

ALIGNED

NOT_ALIGNED_AS_INT

NOT_ALIGNED

getValue

toString

getInstanceFromInt