A sweep can run in either normal or preview mode, which determines the type of result record. In normal mode, a sweep performs an action on the selected candidate objects. If a processing error occurs on a swept object, the sweep generates a result record of type FAILURE. This type of result record describes the failure.
In preview mode, a sweep only selects candidate objects for processing; it does not actually perform an action on the selected objects. For each candidate object, the sweep generates a result record of type PREVIEW. This type of result record identifies the object as one that would be processed if the sweep were operating in normal mode.
To determine result record type, get the SweepResultType property.
You can retrieve result records from a sweep policy or sweep job object, or from an SQL search. You can also delete result records, either manually or through a disposal policy. Permissions on result records are determined by the security defined on the controlling object, that is, the sweep policy or sweep job.
Assembly: FileNet.Api (in FileNet.Api.dll)
Syntax
Visual Basic (Declaration) |
---|
Public Interface ICmSweepResult _ Implements IRepositoryObject, IIndependentlyPersistableObject, IIndependentObject, IEngineObject, _ ICloneable |
C# |
---|
public interface ICmSweepResult : IRepositoryObject, IIndependentlyPersistableObject, IIndependentObject, IEngineObject, ICloneable |
Visual C++ |
---|
public interface class ICmSweepResult : IRepositoryObject, IIndependentlyPersistableObject, IIndependentObject, IEngineObject, ICloneable |
JavaScript |
---|
FileNet.Api.Sweep.ICmSweepResult = function(); FileNet.Api.Sweep.ICmSweepResult.createInterface('FileNet.Api.Sweep.ICmSweepResult'); |
Remarks
Metadata
Auditable: false
AllowsInstances: false
AllowsSubClasses: false
ClassDefinitionName: ClassDefinition
IsDependent: false
IsHidden: true
Name: Id
Searchable: true
StorageType: ObjectStore
SuperclassName: GenericObject