Defines criteria for updating the retention period for objects of a specified class by a policy controlled sweep. When you create a ICmRetentionUpdatePolicy object, the server automatically creates the other objects required for policy-based processing: ICmSweepPolicyRelationship and ICmPolicyControlledSweep. A ICmRetentionUpdatePolicy object can be associated with only one policy controlled sweep.

The rules for modifying the retention date of an object selected by this sweep policy are the same rules that apply for modifying an object's retention date directly with its CmRetentionDate property. For example, this sweep policy cannot be used to update the retention date of an object if the object's CmRetentionDate property is set to PERMANENT.

The CREATE_INSTANCE access right is required on the class definition to create a ICmRetentionUpdatePolicy instance. The MODIFY_RETENTION access right is required on the object store to create, update, or delete instances of this class.

Namespace:  FileNet.Api.Sweep
Assembly:  FileNet.Api (in FileNet.Api.dll)

ToggleSyntax

Visual Basic (Declaration)
Public Interface ICmRetentionUpdatePolicy _
	Implements ICmSweepPolicy, IRepositoryObject, IReplicable, ISubscribable,  _
	IIndependentlyPersistableObject, IIndependentObject, IEngineObject, ICloneable
C#
public interface ICmRetentionUpdatePolicy : ICmSweepPolicy, 
	IRepositoryObject, IReplicable, ISubscribable, IIndependentlyPersistableObject, IIndependentObject, 
	IEngineObject, ICloneable
Visual C++
public interface class ICmRetentionUpdatePolicy : ICmSweepPolicy, 
	IRepositoryObject, IReplicable, ISubscribable, IIndependentlyPersistableObject, IIndependentObject, 
	IEngineObject, ICloneable
JavaScript
FileNet.Api.Sweep.ICmRetentionUpdatePolicy = function();
FileNet.Api.Sweep.ICmRetentionUpdatePolicy.createInterface('FileNet.Api.Sweep.ICmRetentionUpdatePolicy');

ToggleRemarks

Metadata

Auditable: true
AllowsInstances: true
AllowsSubClasses: false
ClassDefinitionName: ReplicableClassDefinition
IsDependent: false
IsHidden: false
Name: DisplayName
Searchable: true
StorageType: ObjectStore
SuperclassName: CmSweepPolicy

ToggleSee Also