Specifies when a content element will expire, so that it can be deleted from a storage area object. A positive value represents the number of minutes the content element must be retained. Other possible values, as enumerated in the
class, are:
- 0: No minimum retention period (content may be deleted at any time).
- -1: Infinite retention period (content can never be deleted).
- -2: Same retention period as the associated fixed content device. (For
objects only.)FixedStorageArea - -101: Reserved for internal use only.
- -102: Retention period is not supported. This is the default if no RetentionPeriod value has been defined for the storage area.
Namespace: FileNet.Api.Admin
Assembly: FileNet.Api (in filenet.api.dll)
Syntax
Visual Basic (Declaration) |
---|
Property RetentionPeriod As Nullable(Of Integer) |
C# |
---|
Nullable<int> RetentionPeriod { get; set; } |
C++ |
---|
property Nullable<int> RetentionPeriod abstract { Nullable<int> get(); void set(Nullable<int> value); } |
J# |
---|
/** property */ public Nullable<int> get_RetentionPeriod(); /** property */ public void set_RetentionPeriod(Nullable<int> value); |
JScript |
---|
public function get RetentionPeriod() : Nullable<int> public function set RetentionPeriod(value : Nullable<int>); |
Remarks
Metadata
AllowsDefaultChange: false
Cardinality: SINGLE
CopyToReservation: false
Datatype: LONG
IsHidden: false
IsOrderable: true
IsSearchable: true
IsValueRequired: false
ModificationAccessRequired: WRITE
PersistenceType: OWN_COLUMN
PropertyDefaultInteger32: -102
PropertyMaximumInteger32: null
PropertyMinimumInteger32: null
RequiresUniqueElements: false
Settability: READ_WRITE
TargetAccessRequired: READ