Represents a background service that repeatedly visits all instances of a specified class residing in a single database table. A policy controlled sweep cannot be created directly with a factory class. It is created indirectly by the server, when you create or update a ICmSweepPolicy object.

The same instance of a policy controlled sweep is subscribed to by all sweep policy objects that target classes whose instances are contained in the same table. If the policy controlled sweep does not already exist for a particular table, the server creates it.

For example, consider a scenario where two sweep policies are created that target Document subclasses DC1 and DC2. Instances of Document subclasses are persisted in the DocVersion table. In this scenario, there currently is no policy controlled sweep instance for the DocVersion table. When a disposal policy is created with a sweep target of DC1, the server creates a policy controlled sweep to visit the DocVersion table for instances of class DC1. When a retention update policy is created with a sweep target of DC2, the server uses the existing policy controlled sweep, which is now configured to sweep over the DocVersion table for instances of both DC1 and DC2.

When a sweep policy object is created, the server automatically creates a ICmSweepRelationship object that links the sweep policy object with an instance of the policy controlled sweep. In the previous example, two ICmSweepRelationship objects are created, one that associates the disposal policy object to the policy controlled sweep instance for the DocVersion table, and one that associates the retention update policy object to the same policy controlled sweep object.

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

ToggleSyntax

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

ToggleRemarks

Metadata

Auditable: true
AllowsInstances: false
AllowsSubClasses: false
ClassDefinitionName: SubscribableClassDefinition
IsDependent: false
IsHidden: false
Searchable: true
StorageType: ObjectStore
SuperclassName: CmSweep

ToggleSee Also