Provides a set of constants for specifying special, non-positive RetentionPeriod property values.

The RetentionPeriod property specifies when a content element will expire, so that it can be deleted from a storage area object. A positive retention period value represents the number of minutes a content element must be retained.


Namespace: FileNet.Api.Constants
Assembly: FileNet.Api (in filenet.api.dll)

Syntax

Visual Basic (Declaration)
Public Enum RetentionPeriod
C#
public enum RetentionPeriod
C++
public enum class RetentionPeriod
J#
public enum RetentionPeriod
JScript
public enum RetentionPeriod

Members

Member NameDescription
DEFAULTDefined as "-2". The same retention period that is defined by the associated fixed content device is applied to the content element. (For FixedStorageArea objects only.)
INFINITEDefined as "-1". The content element is retained for an infinite period, and can never be deleted.
NOT_ALLOWEDDefined as "-102". A retention period is not supported. This is the default if no RetentionPeriod value has been defined for the storage area.
UNDEFINEDDefined as "-101". This constant and its associated value are reserved for internal use only.
ZERODefined as "0". There is no minimum retention period; the content may be deleted at any time.

See Also