The ICmThumbnailRequest type exposes the following members.
Properties
Type | Name | Description |
---|---|---|
![]() | ClassDescription |
The ClassDescription object containing the property metadata for the EngineObject.
(Inherited from IEngineObject.) |
![]() | Creator |
Indicates the name of the user assigned as the creator of the object.
(Inherited from ICmAbstractQueueEntry.)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. |
![]() | 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 ICmAbstractQueueEntry.)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 ICmAbstractQueueEntry.)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). |
![]() | DeferralCount |
The number of times that the queue entry has been deferred for later processing.
This count is incremented when the queue sweep handler determines that the entry cannot currently be processed
because of a correctable problem.
For example, when an advanced storage area is used, a content deletion request is deferred if the content is on a
storage device that the Content Platform Engine has determined to be offline.
(Inherited from ICmAbstractQueueEntry.)The deferred count is separate from the failure count, and does not affect the maximum failures. A deferral is an expected problem that is correctable, whereas a failure is an unexpected problem. Deferred items are scheduled for retry in 5 minutes (specifically, the HeldUntilDate property is set to the current time plus 5 minutes). |
![]() | DeferralData |
Data that has been saved in the queue entry for use in subsequent deferred processing.
(Inherited from ICmAbstractQueueEntry.) |
![]() | ElementSequenceNumber |
A unique sequence number for a content element in a particular document or annotation version.
Server-generated, the number serves as an unchanging identity for the content element.
For annotations, on which you can change content, the element sequence number for a
content element will not change. For example, if you were to change a content element's relative position
within the list of content elements, the element's sequence number would be retained.
Or if you were to replace the first content element with updated content, the content element
would receive a new element sequence number. Element sequence numbers are not reused.
This property can be accessed from a IContentElement-based object, or from IGetContentEvent, representing the event fired when the content element specified in this property is retrieved. |
![]() | FailureCount |
The number of times this queued object has failed.
(Inherited from ICmAbstractQueueEntry.)When this property is equal to or exceeds the MaximumFailures property on ICmQueueSweep, the QueueEntryStatus property is set to FAILED, and the sweep service no longer selects the entry for processing. To restart processing of a queue entry with a FAILED status, reset this property to zero, and the QueueEntryStatus property is changed from FAILED to RETRY_WAIT. For a background search (ICmBackgroundSearch), when this property is equal to or exceeds the MaximumFailures property on ICmBackgroundSearch, the background search stops. |
![]() | HeldUntilDate |
The date and time when the current lease on this item expires,
or when to next retry it following a failure or deferral.
The property is set to null when the FailureCount property is set to zero.
(Inherited from ICmAbstractQueueEntry.) |
![]() | 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 ICmAbstractQueueEntry.)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. |
![]() | InputDocument |
Specifies the input document to use for this publish or thumbnail request.
|
![]() | LastFailureReason |
For IIndexJob and ICmIndexRequest objects, this property identifies the final failure
condition for the index job.
(Inherited from ICmAbstractQueueEntry.)For an IReplicationJournalEntry object, this property provides a description of the latest failure condition, if any, for the replication operation that generates this journal entry. For an ICmThumbnailRequest object, this property states why document thumbnail generation failed. For an ICmBackgroundSearch object, this property provides a description of the latest failure condition, if any, for the background search operation that generates this journal entry. For an ICmTask 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: ICmTask.changeState(SET_EXCEPTION); To reset LastFailureReason to a null value, clear the exception: ICmTask.changeState(CLEAR_EXCEPTION). |
![]() | LastModifier |
Indicates the name of the user who last modified the object.
(Inherited from ICmAbstractQueueEntry.)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). |
![]() | LeaseHolderId |
An id assigned to a batch of objects leased for processing.
(Inherited from ICmAbstractQueueEntry.) |
![]() | Properties |
The IProperties collection of properties for the EngineObject.
(Inherited from IEngineObject.) |
![]() | QueueEntryStatus |
The status of the queue entry.
The property takes a value of type
QueueEntryStatus.
(Inherited from ICmAbstractQueueEntry.) |