Provides a set of constants for setting the execution mode of a sweep job or policy.
Namespace:
FileNet.Api.ConstantsAssembly: FileNet.Api (in FileNet.Api.dll)
Syntax
Visual Basic (Declaration) |
---|
Public Enumeration SweepMode |
C# |
---|
public enum SweepMode |
Visual C++ |
---|
public enum class SweepMode |
JavaScript |
---|
FileNet.Api.Constants.SweepMode = function(); FileNet.Api.Constants.SweepMode.createEnum('FileNet.Api.Constants.SweepMode', false); |
Members
Type | Member name | Description |
---|---|---|
SWEEP_MODE_NORMAL |
The sweep job or policy will execute in a non-preview mode;
that is, it will perform an action on the selected candidate objects,
and it will increment the ExaminedObjectCount and ProcessedObjectCount counters.
If a processing error occurs on a swept object, the sweep generates a
ICmSweepResult
object of type FAILURE.
For a ICmSweepJob, failure reporting can be suppressed by setting the RecordFailures property to false. For a ICmSweepPolicy, failure reporting can be suppressed by setting the SweepResultIterationKeepCount to zero. | |
SWEEP_MODE_PREVIEW_COUNTERS_ONLY |
The sweep job or sweep policy will not perform an action on the selected candidate objects,
nor will it generate a ICmSweepResult object
of type PREVIEW for each object that is selected by the sweep.
With this preview mode setting, the sweep will only increment
the ExaminedObjectCount and ProcessedObjectCount counters.
| |
SWEEP_MODE_PREVIEW |
The sweep job or sweep policy will not perform an action on the selected candidate objects.
(For a custom sweep job or sweep policy, the custom SweepActionHandler implementation does not run.)
It will generate a ICmSweepResult object
of type PREVIEW for each object that is selected by the sweep,
indicating that the swept object would be processed if the sweep were run in normal execution mode.
The sweep will also increment the ExaminedObjectCount and ProcessedObjectCount counters.
|