The ICmSweep type exposes the following members.

ToggleProperties

Type NameDescription
Public propertyAuditedEvents
An EventSet collection of the Event objects containing the audited events that have occurred for the object.
Public propertyClassDescription
The ClassDescription object containing the property metadata for the EngineObject.
(Inherited from IEngineObject.)
Public propertyCreator
Indicates the name of the user assigned as the creator of the object.

Settability of this property is read-only for most users. For users who have been granted privileged write access (AccessRight.PRIVILEGED_WRITE), this property is settable only on create. After initial object creation, this property is read-only for all users.

Public propertyDateCreated
Indicates the date and time the object was created. The Content Engine server stores dates and times using Coordinated Universal Time (UTC). For more information, see Timestamps.

Settability of this property is read-only for most users. For users who have been granted privileged write access (AccessRight.PRIVILEGED_WRITE), this property is settable only on create. After initial object creation, this property is read-only for all users.

Public propertyDateLastModified
Indicates the date and time the object was last modified. The Content Engine server stores dates and times using Coordinated Universal Time (UTC). For more information, see Timestamps.

Settability of this property is read-only for most users. For users who have been granted privileged write access (AccessRight.PRIVILEGED_WRITE), this property is read/write. (The read/write access for those users can only change if a change is made to the ACL on the object store that controls who has privileged write access to objects in that object store).

Public propertyExaminedObjectCount
Public propertyFailedObjectCount
For a sweep job, which runs only once, the number of objects that failed when applying the sweep action. For an ongoing sweep, the cumulative number of objects that failed in the current iteration plus in all of the previous iterations.

For a background search, the value of this property is always zero.

Public propertyId
A representation of the Globally Unique Identifier (GUID), a unique 128-bit number, that is assigned to this Content Engine object when the object is created. When converted to a string, the Id property is typically depicted as 32 hexadecimal characters enclosed by brackets in the following format: {xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx}. For example, {3F2504E0-4F89-11D3-9A0C-0305E82C3301}.

For IUser and IGroup classes, the Id property takes the value of the Security Identifier (SID) rather than the 128-bit GUID. The string representation of the SID is in this example format: S-1-5-21-1559522492-2815155736-3711640725-55269. When Active Directory is used as the directory service for IBM FileNet P8, IUser.Id and IGroup.Id always return the current SID for the principal, even if this user or group has only historical SIDs populating the Active Directory server.

For a given property representation, the Id property has the following characteristics:

  • PropertyDescription.Id is equal to PropertyTemplate.Id, which is equal to PropertyDefinition.PrimaryId.
  • PropertyDefinition.Id is not equal to PropertyDefinition.PrimaryId.
  • PropertyDefinition.Id is not equal to PropertyDescription.Id.

For a newly created document object, you can override the Id property of its associated VersionSeries object before you save or check in the document for the first time.

Public propertyInterBatchDelay
The minimum number of milliseconds a sweep will wait before running back-to-back sweep queries. A sweep iteration consists of multiple queries, each of which returns a batch of candidate items for processing.

The property setting on the ICmSweep object overrides the property setting on the ICmSweepConfiguration global object. If the property is set to null on the ICmSweep object, then the InterBatchDelay setting on the ICmSweepConfiguration object is used.

Public propertyLastModifier
Indicates the name of the user who last modified the object.

Settability of this property is read-only for most users. For users who have been granted privileged write access (AccessRight.PRIVILEGED_WRITE), this property is read/write. (The read/write access for those users could only change if a change is made to the ACL on the object store that controls who has privileged write access to objects in that object store).

Public propertyMaxSweepWorkers
The maximum number of worker threads to be allocated for processing a sweep.

For an ICmBackgroundSearch object, this property is ignored.

Public propertyOwner
Manages the security owner assigned to the object.
Public propertyPermissions
Manages the discretionary permissions assigned to the object.
Public propertyProcessedObjectCount
For a sweep job, which runs only once, the number of objects processed during the sweep. For an ongoing sweep, the cumulative number of objects processed in the current iteration plus in all of the previous iterations.

For a background search, the number of ICmAbstractSearchResult objects that are produced as a result of the search. The value is the same as in the ExaminedObjectCount property unless you use SQL aggregate functions and the GROUP BY clause in the search. In that case, a ICmAbstractSearchResult object reflects the aggregation of query result rows.

Public propertyProperties
The IProperties collection of properties for the EngineObject.
(Inherited from IEngineObject.)
Public propertySweepEndDate
A timestamp indicating when the sweep was completed. If NULL, the sweep has not completed yet.
Public propertySweepStartDate
A timestamp indicating when the currently running sweep started. For a sweep policy or queue sweep that is not currently in progress, the property is set to null. For a sweep job, the property remains set to a timestamp value even after the job has completed.
Public propertySweepTarget
Specifies the class for which instances will be swept. Set this property to a class that is valid for the type of sweep to be run.

For a background search sweep, this property is set automatically to the background search result class.

Public propertySweepTimeslots
A list of ICmTimeslot objects that determine the schedule for sweep processing. The property setting on the ICmSweep object overrides the property setting on the ICmSweepConfiguration global object. If the property is set to null on the ICmSweep object, then the timeslot setting on the ICmSweepConfiguration object is used.

ToggleSee Also