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) |
|---|
<ObsoleteAttribute("Deprecated as of release 5.2.0")> _ Public Enumeration RetentionPeriod |
| C# |
|---|
[ObsoleteAttribute("Deprecated as of release 5.2.0")] public enum RetentionPeriod |
| Visual C++ |
|---|
[ObsoleteAttribute(L"Deprecated as of release 5.2.0")] public enum class RetentionPeriod |
| JavaScript |
|---|
FileNet.Api.Constants.RetentionPeriod = function(); FileNet.Api.Constants.RetentionPeriod.createEnum('FileNet.Api.Constants.RetentionPeriod', false); |
Members
| Type | Member name | Description |
|---|---|---|
| DEFAULT | Obsolete.
Defined 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.)
| |
| INFINITE | Obsolete.
Defined as "-1". The content element is retained for an infinite period,
and can never be deleted.
| |
| NOT_ALLOWED | Obsolete.
Defined as "-102". A retention period is not supported. This is the default
if no RetentionPeriod value has been defined for the storage area.
| |
| UNDEFINED | Obsolete.
Defined as "-101". This constant and its associated value are reserved for
internal use only.
| |
| ZERO | Obsolete.
Defined as "0". There is no minimum retention period; the content may be
deleted at any time.
|
See Also
