RetentionPeriod

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

Deprecated.
As of release 5.2.0.
```
public class RetentionPeriod
extends java.lang.Object
```
Provides a set of constants for specifying special, non-positive RetentionPeriod property values. A positive retention period value represents the number of minutes a content element must be retained. This class provides a set of constants for specifying the following non-positive values:
- "0", defined as ZERO
- "-1", defined as INFINITE
- "-2", defined as DEFAULT
- "-101", defined as UNDEFINED
- "-102", defined as NOT_ALLOWED

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.Integer`	`DEFAULT` Deprecated.
`static int`	`DEFAULT_AS_INT` Deprecated. As of release 5.2.0.
`static java.lang.Integer`	`INFINITE` Deprecated.
`static int`	`INFINITE_AS_INT` Deprecated. As of release 5.2.0.
`static java.lang.Integer`	`NOT_ALLOWED` Deprecated.
`static int`	`NOT_ALLOWED_AS_INT` Deprecated. As of release 5.2.0.
`static java.lang.Integer`	`UNDEFINED` Deprecated.
`static int`	`UNDEFINED_AS_INT` Deprecated. As of release 5.2.0.
`static java.lang.Integer`	`ZERO` Deprecated.
`static int`	`ZERO_AS_INT` Deprecated. As of release 5.2.0.

Method Summary

All Methods Static Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`static java.lang.String`	`toString(int val)` Deprecated. As of release 5.2.0.
`static java.lang.String`	`toString(java.lang.Integer val)` Deprecated. As of release 5.2.0.

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

- Field Detail
  - ZERO_AS_INT
```
public static final int ZERO_AS_INT
```
    Deprecated. As of release 5.2.0.
    
    Specifies no minimum retention period (content can be deleted at any time).
    
    See Also:
    
    Constant Field Values
  - ZERO
```
public static final java.lang.Integer ZERO
```
    Deprecated.
  - INFINITE_AS_INT
```
public static final int INFINITE_AS_INT
```
    Deprecated. As of release 5.2.0.
    
    Specifies an infinite retention period (content can never be deleted).
    
    See Also:
    
    Constant Field Values
  - INFINITE
```
public static final java.lang.Integer INFINITE
```
    Deprecated.
  - DEFAULT_AS_INT
```
public static final int DEFAULT_AS_INT
```
    Deprecated. As of release 5.2.0.
    
    Specifies the same retention period as the associated fixed content device. (For FixedStorageArea objects only.)
    
    See Also:
    
    Constant Field Values
  - DEFAULT
```
public static final java.lang.Integer DEFAULT
```
    Deprecated.
  - UNDEFINED_AS_INT
```
public static final int UNDEFINED_AS_INT
```
    Deprecated. As of release 5.2.0.
    
    Reserved for internal use only.
    
    See Also:
    
    Constant Field Values
  - UNDEFINED
```
public static final java.lang.Integer UNDEFINED
```
    Deprecated.
  - NOT_ALLOWED_AS_INT
```
public static final int NOT_ALLOWED_AS_INT
```
    Deprecated. As of release 5.2.0.
    
    Specifies that a retention period is not supported. This is the default if a RetentionPeriod value has not been defined for the storage area.
    
    See Also:
    
    Constant Field Values
  - NOT_ALLOWED
```
public static final java.lang.Integer NOT_ALLOWED
```
    Deprecated.
- Method Detail
  - toString
```
public static java.lang.String toString(java.lang.Integer val)
```
    Deprecated. As of release 5.2.0.
    
    Returns the symbolic name of the retention period constant if it corresponds to the given value. Otherwise, returns the given Integer as a string.
  - toString
```
public static java.lang.String toString(int val)
```
    Deprecated. As of release 5.2.0.
    
    Returns the symbolic name of the retention period constant if it corresponds to the given value. Otherwise, returns the given int as a string.

Methods inherited from class java.lang.Object

ZERO_AS_INT

ZERO

INFINITE_AS_INT

INFINITE

DEFAULT_AS_INT

DEFAULT

UNDEFINED_AS_INT

UNDEFINED

NOT_ALLOWED_AS_INT

NOT_ALLOWED

toString

toString