Represents a background task that updates the retention date on objects that support it.
A ICmRetentionUpdateJob performs a one-time sweep, updating the
CmRetentionDate property on all instances that meet the criteria set in the filter expression.
For this type of sweep, you must set the sweep target to a Document, Folder,
Annotation, or CustomObject class or subclass.
The CREATE_INSTANCE access right is required on the class definition to create a ICmRetentionUpdateJob 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)
Syntax
| Visual Basic (Declaration) |
|---|
Public Interface ICmRetentionUpdateJob _ Implements IRepositoryObject, ICmSweepJob, ICmSweep, ISubscribable, _ IIndependentlyPersistableObject, IIndependentObject, IEngineObject, ICloneable |
| C# |
|---|
public interface ICmRetentionUpdateJob : IRepositoryObject, ICmSweepJob, ICmSweep, ISubscribable, IIndependentlyPersistableObject, IIndependentObject, IEngineObject, ICloneable |
| Visual C++ |
|---|
public interface class ICmRetentionUpdateJob : IRepositoryObject, ICmSweepJob, ICmSweep, ISubscribable, IIndependentlyPersistableObject, IIndependentObject, IEngineObject, ICloneable |
| JavaScript |
|---|
FileNet.Api.Sweep.ICmRetentionUpdateJob = function(); FileNet.Api.Sweep.ICmRetentionUpdateJob.createInterface('FileNet.Api.Sweep.ICmRetentionUpdateJob'); |
Remarks
Metadata
Auditable: true
AllowsInstances: true
AllowsSubClasses: true
ClassDefinitionName: SubscribableClassDefinition
IsDependent: false
IsHidden: false
Name: DisplayName
Searchable: true
StorageType: ObjectStore
SuperclassName: CmSweepJob