Represents a background task that performs a one-time sweep over a specified target class and retrieves instances that meet the criteria set on the job's filter expression. The custom sweep job 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 job, you set a ICmSweepAction on the custom sweep job.

See Custom Sweeps, Action Handlers

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

ToggleSyntax

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

ToggleRemarks

Metadata

Auditable: true
AllowsInstances: true
AllowsSubClasses: true
ClassDefinitionName: SubscribableClassDefinition
IsDependent: false
IsHidden: false
Name: DisplayName
Searchable: true
StorageType: ObjectStore
SuperclassName: CmSweepJob

ToggleSee Also