Defines the action to be taken when a custom sweep (ICmCustomSweepJob, ICmCustomSweepPolicy, or ICmCustomQueueSweep) is invoked. The action is coded by the user as a Java or JavaScript implementation of the SweepActionHandler interface. The user-implemented action is set on ICmSweepAction with the CodeModule or ScriptText property, depending on how the action is implemented.

See Custom Sweeps, Action Handlers: Restrictions and Best Practices, Deploying Java Action Handlers.

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

ToggleSyntax

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

ToggleRemarks

Metadata

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

ToggleSee Also