Specifies whether the retention period is set to the current Centera system setting (true) or not (false).
This flag only applies when a fixed storage area's retention period is configured to use the retention period
of the fixed content device (that is, when the fixed storage area's RetentionPeriod property is set to -2).
Normally the provider will examine the value of the FP_RETENTION pool capability and explicitly set the retention
period to either zero or infinite, depending on the capability setting. When DefaultRetentionPassThrough is set
to 1, the retention period is set to RETENTION_PERIOD_DEFAULT (meaning that the Clips use the current Centera
system setting, which can be altered by changing the compliance mode of the system).
Namespace:
FileNet.Api.Admin
Assembly:
FileNet.Api (in FileNet.Api.dll)
Syntax
| Visual Basic (Declaration) |
|---|
Property DefaultRetentionPassThrough As Nullable(Of Boolean) |
| C# |
|---|
Nullable<bool> DefaultRetentionPassThrough { get; set; } |
| Visual C++ |
|---|
property Nullable<bool> DefaultRetentionPassThrough { Nullable<bool> get (); void set (Nullable<bool> value); } |
| JavaScript |
|---|
function get_defaultRetentionPassThrough(); function set_defaultRetentionPassThrough(value); |
Remarks
Metadata
AllowsDefaultChange: false
Cardinality: SINGLE
CopyToReservation: false
DataType: BOOLEAN
IsHidden: true
IsOrderable: false
IsSearchable: false
IsValueRequired: false
ModificationAccessRequired: WRITE
PersistenceType: OWN_COLUMN
PropertyDefaultBoolean: false
RequiresUniqueElements: false
Settability: READ_WRITE
TargetAccessRequired: READ