com.filenet.api.admin

Interface CmTivoliManagementClass

All Superinterfaces:

EngineObject, IndependentlyPersistableObject, IndependentObject, java.io.Serializable

public interface CmTivoliManagementClass
extends IndependentlyPersistableObject

A management class that represents a specific retention setting for an IBM® Tivoli® Storage Manager (TSM) server. A TivoliFixedContentDevice class can have one or more CmTivoliMangementClass classes associated with it (via its TSMManagementClasses property). Each management class that you create represents a retention scheme type and a retention period that you can associate with a specific TivoliFixedContentDevice class. Note that if data retention protection is turned off (controlled via the TSMArchiveProtectionFlag property of a TivoliFixedContentDevice class), any management classes that specify a chronological retention scheme will be made unavailable by the Content Engine server.

There are two types or retention schemes that a management class can represent: chronological or event. The type of retention scheme used by the management class determines how the retention period is interpreted:

• In 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 TSM archive until after the retention period has expired.
• In 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.

Metadata

Auditable: false
AllowsInstances: false
AllowsSubClasses: false
ClassDefinitionName: None
IsDependent: false
IsHidden: false
Searchable: false
StorageType: Domain
SuperclassName: GenericObject

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	get_DescriptiveText() Returns the value of the DescriptiveText property.
java.lang.String	get_Name() Returns the value of the Name property.
java.lang.Integer	get_TSMMinimumRetention() Returns the value of the TSMMinimumRetention property.
java.lang.Integer	get_TSMRetentionInitiation() Returns the value of the TSMRetentionInitiation property.
java.lang.Integer	get_TSMRetentionPeriod() Returns the value of the TSMRetentionPeriod property.

Methods inherited from interface com.filenet.api.core.IndependentlyPersistableObject

addPendingAction, clearPendingActions, delete, getAccessAllowed, getPendingActions, getUpdateSequenceNumber, isCurrent, save, save, setUpdateSequenceNumber

Methods inherited from interface com.filenet.api.core.IndependentObject

fetchProperties, fetchProperties, fetchProperty, fetchProperty, getObjectReference, refresh, refresh, refresh

Methods inherited from interface com.filenet.api.core.EngineObject

get_ClassDescription, getClassName, getConnection, getProperties, getSuperClasses

Method Detail

get_Name

java.lang.String get_Name()

Returns the value of the Name property. For more information, see Name Property.

get_DescriptiveText

java.lang.String get_DescriptiveText()

Returns the value of the DescriptiveText property. For more information, see DescriptiveText Property.

get_TSMRetentionPeriod

java.lang.Integer get_TSMRetentionPeriod()

Returns the value of the TSMRetentionPeriod property. For more information, see TSMRetentionPeriod Property.

get_TSMRetentionInitiation

java.lang.Integer get_TSMRetentionInitiation()

Returns the value of the TSMRetentionInitiation property. For more information, see TSMRetentionInitiation Property.

get_TSMMinimumRetention

java.lang.Integer get_TSMMinimumRetention()

Returns the value of the TSMMinimumRetention property. For more information, see TSMMinimumRetention Property.