Represents a background task that performs an indefinite number of sweeps over a specified target
class and retrieves instances that meet the criteria set on the policy's filter expression.
The custom sweep policy passes retrieved instances to a user
implementation of the SweepActionHandler Java interface, which performs a custom action on the instances.
To associate an implemented action handler with a custom sweep policy, you set a
ICmSweepAction on the custom sweep policy.
See Custom Sweeps, Action Handlers.
Namespace:
FileNet.Api.Sweep
Assembly:
FileNet.Api (in FileNet.Api.dll)
Syntax
| Visual Basic (Declaration) |
|---|
Public Interface ICmCustomSweepPolicy _ Implements IRepositoryObject, ICmSweepPolicy, IReplicable, ISubscribable, _ IIndependentlyPersistableObject, IIndependentObject, IEngineObject, ICloneable |
| C# |
|---|
public interface ICmCustomSweepPolicy : IRepositoryObject, ICmSweepPolicy, IReplicable, ISubscribable, IIndependentlyPersistableObject, IIndependentObject, IEngineObject, ICloneable |
| Visual C++ |
|---|
public interface class ICmCustomSweepPolicy : IRepositoryObject, ICmSweepPolicy, IReplicable, ISubscribable, IIndependentlyPersistableObject, IIndependentObject, IEngineObject, ICloneable |
| JavaScript |
|---|
FileNet.Api.Sweep.ICmCustomSweepPolicy = function(); FileNet.Api.Sweep.ICmCustomSweepPolicy.createInterface('FileNet.Api.Sweep.ICmCustomSweepPolicy'); |
Remarks
Metadata
Auditable: true
AllowsInstances: true
AllowsSubClasses: true
ClassDefinitionName: ReplicableClassDefinition
IsDependent: false
IsHidden: false
Name: DisplayName
Searchable: true
StorageType: ObjectStore
SuperclassName: CmSweepPolicy