CmSweep Properties

An EventSet collection of the Event objects containing the audited events that have occurred for the object.

Specifies a ClassDescription object containing the fixed description (immutable metadata) of the class from which this object is instantiated.

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.

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.

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).

For a sweep job, which runs only once, the number of objects that were examined in the iteration. For an ongoing sweep, the cumulative number of objects that were examined in the current iteration plus in all of the previous iterations.

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.

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 User and Group 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, calls to User.get_Id() and Group.get_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.get_Id() is equal to PropertyTemplate.get_Id(), which is equal to PropertyDefinition.get_PrimaryId().
• PropertyDefinition.get_Id() is not equal to PropertyDefinition.get_PrimaryId().
• PropertyDefinition.get_Id() is not equal to PropertyDescription.get_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.

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 CmSweep object overrides the property setting on the CmSweepConfiguration global object. If the property is set to null on the CmSweep object, then the InterBatchDelay setting on the CmSweepConfiguration object is used.

Indicates the name of the user who last modified this 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).

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

Manages the security owner assigned to the object.

Manages the discretionary permissions assigned to the object.

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.

A timestamp indicating when the sweep was completed. If NULL, the sweep has not completed yet.

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.

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.

A list of CmTimeslot objects that determine the schedule for sweep processing. The property setting on the CmSweep object overrides the property setting on the CmSweepConfiguration global object. If the property is set to null on the CmSweep object, then the timeslot setting on the CmSweepConfiguration object is used.

The current object. The primary purpose of this property is to enable the expression of relationships among objects in a Content Engine query and to select candidate objects in the query results.