Specifies the type of retention scheme for a management class: chronological or event.
The setting of this property determines how the retention periods specified by the
TSMRetentionPeriod and TSMMinimumRetention properties will be interpreted.
Namespace:
FileNet.Api.AdminThis property can have one of the following values:
- 0: Specifies a chronological retention scheme. The retention period is determined by the value of the TSMRetentionPeriod property. After a document is checked in for the first time, the retention period is initiated and a hold is place on the document to prevent deletion in the IBM® Tivoli® Storage Manager archive until after the retention period has expired.
- 1: Specifies an event retention scheme. The retention period is determined by the value of the TSMMinimumRetention property. In this type of retention scheme, you must set the TSMRetentionPeriod property to 0. The retention period is initiated after an object has been deleted from an object store.
Assembly: FileNet.Api (in FileNet.Api.dll)
Syntax
Visual Basic (Declaration) |
---|
ReadOnly Property TSMRetentionInitiation As Nullable(Of Integer) |
C# |
---|
Nullable<int> TSMRetentionInitiation { get; } |
Visual C++ |
---|
property Nullable<int> TSMRetentionInitiation { Nullable<int> get (); } |
JavaScript |
---|
function get_tsmRetentionInitiation(); |
Remarks
Metadata
AllowsDefaultChange: false
Cardinality: SINGLE
CopyToReservation: false
DataType: LONG
IsHidden: false
IsOrderable: false
IsSearchable: false
IsValueRequired: false
ModificationAccessRequired: WRITE
PersistenceType: NOT_PERSISTENT
PropertyDefaultInteger32: null
PropertyMaximumInteger32: null
PropertyMinimumInteger32: null
RequiresUniqueElements: false
Settability: READ_ONLY
TargetAccessRequired: READ