CmIndexRequest Properties

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

A bitmask of IndexingFailureCode constants that identify the types of indexing failures that have occurred as a result of an index request for a CBR-enabled object. If there are no indexing failures, the CmIndexingFailureCode property returns a value of zero.

If you set the value of the IndexingFailureRecordingLevel property of an ObjectStore object to PROPAGATE_TO_SOURCE, the error information is propagated to the CmIndexingFailureCode property of all CBR-enabled objects.

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

Indicates the date and time of the index request.

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.

An IndexArea object representing the index area that contains the IBM® Content Search Services index referenced by the IndexationId property.

Identifies the index job for which index requests were generated.

Indicates the status of the index request.

The object ID (GUID) of the IBM® Content Search Services index that is used for this object. This value is null for objects that are full-text indexed prior to the 4.0 release.

The server sets this property if a string-valued property of this object is CBR-enabled. An object is considered to be CBR-enabled if you set the PropertyDefinitionString.IsCBREnabled property of the property definition of one of the object's string-valued properties to true.

An IndexingOperation constant that specifies the type of operation for this IBM® Content Search Services index request. The only user-settable value of the IndexingOperation property is SKIP; otherwise, this property is read-only.

To skip the indexing of a CBR-enabled object, change the index request operation to a SKIP operation. After you set the IndexingOperation property to SKIP, the Content Engine server sets the CmIndexingFailureCode property of the index request to MARKED_AS_SKIPPED and sets the IndexationId property of the CBR-enabled object to null. This property can be set to SKIP only if the IndexRequestStatus property of this index request has a value of NOT_STARTED or IN_PROGRESS.

The IndexingOperation property can have one of the following values:

• CREATE: Indicates that an index entry is to be created.
• UPDATE: Indicates that an existing index entry is to be replaced with an updated entry. An update index request is generated if the CBR-enabled object is modified and has a non-null IndexationId property value.
• DELETE: Indicates that an index entry is to be deleted.
• SKIP: Indicates that an index request is to be skipped. The Content Engine server sets the CmIndexingFailureCode property of the index request to MARKED_AS_SKIPPED and sets the IndexationId property of the CBR-enabled object to null. This value is the only user-settable value.
• NO_OP: For internal use only.

For IndexJob and CmIndexRequest objects, this property identifies the final failure condition for the index job.

For a ReplicationJournalEntry object, this property provides a description of the latest failure condition, if any, for the replication operation that generates this journal entry.

For a CmThumbnailRequest object, this property states why document thumbnail generation failed.

For a CmTask object, this property indicates why the object has been set to the exception state. This property is settable only during the SET_EXCEPTION changeState transaction, for example:

CmTask.changeState(SET_EXCEPTION);
CmTask.set_LastFailureReason ( "Required document was not attached to workflow.");
CmTask.save();

To reset LastFailureReason to a null value, clear the exception: CmTask.changeState(CLEAR_EXCEPTION).

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

Specifies the number of remaining attempts to process the queue item. When the retry count reaches 0 for a queue item, the item is considered "dead" and no further retries are attempted. If you want to retry a "dead" queue item, reset the retry count from 0 to a positive number. The range of valid values is 0 to 16.

For index requests, indicates the sequence number (the database row) of the index request in the table.

For a subclass of CmAbstractSequential, indicates the sequence number of the entry inserted in the table. The sequence number can be used to process entries in the order they were created. A sequence number is assigned to each object at creation, and although the values are not necessarily consecutive (there might be gaps). they are guaranteed to be unique and monotonically increasing.

For an event object, the event's source object at the time the event occurred. Note that the state of the object might be different from its prior or current state. To get the state of the source object prior to the event, use get_OriginalObject on subclasses of ObjectChangeEvent that provide this method.

For CmSweepResult, the object that a sweep running in preview mode selected as a candidate for processing, or that a sweep running in normal mode failed to process.

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.