The duration of the default retention period for the class defined by this class definition. The time unit
(days, for example) in which the value of the
DefaultRetentionPeriod property is expressed is determined by the
value of the
RetentionPeriodUnits property. For a new instance of the class defined by this class definition,
the Content Engine server calculates the default retention date and time of the instance by adding the retention duration,
expressed in the specified period units, to the date and time when the instance is created. The
CmRetentionDate property
of the instance is initially set to the default retention date and time, unless it is overridden.
Instead of a retention period, the DefaultRetentionPeriod property can be set to one of the following
RetentionConstants constants:
- INDEFINITE: Indefinite retention period. Specifies that the instance of the class defined by this class definition
can only be deleted if its CmRetentionDate property has been converted to a expiration date and time and that date and time
is in the past.
- PERMANENT: Permanent retention period. Specifies that the instance of the class
defined by this class definition can never be deleted.
Namespace:
FileNet.Api.Admin
Assembly:
FileNet.Api (in FileNet.Api.dll)
Visual Basic (Declaration) |
---|
Property DefaultRetentionPeriod As Nullable(Of Integer) |
C# |
---|
Nullable<int> DefaultRetentionPeriod { get; set; } |
Visual C++ |
---|
property Nullable<int> DefaultRetentionPeriod {
Nullable<int> get ();
void set (Nullable<int> value);
} |
JavaScript |
---|
function get_defaultRetentionPeriod();
function set_defaultRetentionPeriod(value); |