com.filenet.api.constants
Class RetentionPeriod

java.lang.Object
  extended by com.filenet.api.constants.RetentionPeriod

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:


Field Summary
static java.lang.Integer DEFAULT
           
static int DEFAULT_AS_INT
          Specifies the same retention period as the associated fixed content device.
static java.lang.Integer INFINITE
           
static int INFINITE_AS_INT
          Specifies an infinite retention period (content can never be deleted).
static java.lang.Integer NOT_ALLOWED
           
static int NOT_ALLOWED_AS_INT
          Specifies that a retention period is not supported.
static java.lang.Integer UNDEFINED
           
static int UNDEFINED_AS_INT
          Reserved for internal use only.
static java.lang.Integer ZERO
           
static int ZERO_AS_INT
          Specifies no minimum retention period (content can be deleted at any time).
 
Method Summary
static java.lang.String toString(int val)
          Returns the symbolic name of the retention period constant if it corresponds to the given value.
static java.lang.String toString(java.lang.Integer val)
          Returns the symbolic name of the retention period constant if it corresponds to the given value.
 
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
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

INFINITE_AS_INT

public static final int INFINITE_AS_INT
Specifies an infinite retention period (content can never be deleted).

See Also:
Constant Field Values

INFINITE

public static final java.lang.Integer INFINITE

DEFAULT_AS_INT

public static final int DEFAULT_AS_INT
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

UNDEFINED_AS_INT

public static final int UNDEFINED_AS_INT
Reserved for internal use only.

See Also:
Constant Field Values

UNDEFINED

public static final java.lang.Integer UNDEFINED

NOT_ALLOWED_AS_INT

public static final int NOT_ALLOWED_AS_INT
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
Method Detail

toString

public static java.lang.String toString(java.lang.Integer val)
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)
Returns the symbolic name of the retention period constant if it corresponds to the given value. Otherwise, returns the given int as a string.



© Copyright IBM Corporation 2006, 2008. All rights reserved.