The ICmPolicyControlledSweep type exposes the following members.
Properties
Type | Name | Description |
---|---|---|
![]() | AuditedEvents |
An EventSet collection of the Event objects containing the audited events that have occurred for the object.
(Inherited from ICmSweep.) |
![]() | ClassDescription |
The ClassDescription object containing the property metadata for the EngineObject.
(Inherited from IEngineObject.) |
![]() | CompletedIterations |
The number of sweep iterations that have occurred for a policy-controlled sweep.
|
![]() | Creator |
Indicates the name of the user assigned as the creator of the object.
(Inherited from ICmSweep.)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. |
![]() | CurrentExaminedObjectCount |
The number of objects that were examined during the current sweep iteration
of an ongoing sweep.
|
![]() | CurrentFailedObjectCount |
The number of objects for which the processing failed during the current sweep iteration
of an ongoing sweep.
|
![]() | CurrentProcessedObjectCount |
The number of objects that were processed during the current sweep iteration
of an ongoing sweep.
|
![]() | DateCreated |
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.
(Inherited from ICmSweep.)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. |
![]() | DateLastModified |
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.
(Inherited from ICmSweep.)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). |
![]() | ExaminedObjectCount | (Inherited from ICmSweep.) |
![]() | FailedObjectCount |
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.
(Inherited from ICmSweep.)For a background search, the value of this property is always zero. |
![]() | FilteredQueryTimeout |
Indicates whether the queries issued during a sweep iteration include the conditions of the filter expression
(as defined in the FilterExpression property).
FilteredQueryTimeout can be used to enhance job and policy sweep performance.
When FilteredQueryTimeout is set to the default value of 0, a sweep first issues queries to retrieve candidate objects from the database, and next applies the filter expression conditions on the candidate objects to determine which objects to process. When the FilteredQueryTimeout value is greater than 0, then the queries issued to the database include the conditions of the filter expression in the WHERE clause. The value of the FilteredQueryTimeout property is used to set a time limit on the query. The time limit is applied only to the first query of the sweep iteration. If the query time limit is exceeded, then the query terminates and the sweep falls back to using a query that does not contain the filter expression in the WHERE clause. The use of the FilteredQueryTimeout property is a trade-off between the sweep issuing longer-running database queries or evaluating candidate objects before processing them. For more information, see Optimizing sweeps with FilteredQueryTimeout. |
![]() | Id |
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}.
(Inherited from ICmSweep.)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:
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. |
![]() | InterBatchDelay |
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.
(Inherited from ICmSweep.)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. |
![]() | InterSweepDelay |
The minimum number of seconds after a sweep iteration has completed before the next iteration can start.
|
![]() | LastModifier |
Indicates the name of the user who last modified the object.
(Inherited from ICmSweep.)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). |
![]() | MaxSweepWorkers |
The maximum number of worker threads to be allocated for processing a sweep.
(Inherited from ICmSweep.)For an ICmBackgroundSearch object, this property is ignored. |
![]() | NextStartTime |
The earliest time the next sweep iteration can start.
|
![]() | Owner |
Manages the security owner assigned to the object.
(Inherited from ICmSweep.) |
![]() | Permissions |
Manages the discretionary permissions assigned to the object.
(Inherited from ICmSweep.) |
![]() | ProcessedObjectCount |
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.
(Inherited from ICmSweep.)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. |
![]() | Properties |
The IProperties collection of properties for the EngineObject.
(Inherited from IEngineObject.) |
![]() | SweepEndDate |
A timestamp indicating when the sweep was completed. If NULL, the sweep has not completed yet.
(Inherited from ICmSweep.) |
![]() | SweepStartDate |
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.
(Inherited from ICmSweep.) |
![]() | SweepSubscribers |
A collection of sweep relationship objects referencing policy objects.
The policy objects subscribe to this policy controlled sweep.
|
![]() | SweepTarget |
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.
(Inherited from ICmSweep.)For a background search sweep, this property is set automatically to the background search result class. |
![]() | SweepTimeslots |
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.
(Inherited from ICmSweep.) |