com.filenet.api.sweep

Interface CmThumbnailRequest

All Superinterfaces:

CmAbstractQueueEntry, EngineObject, IndependentlyPersistableObject, IndependentObject, RepositoryObject, java.io.Serializable

public interface CmThumbnailRequest
extends RepositoryObject, CmAbstractQueueEntry

Represents a request to generate a thumbnail image for a ContentElement of a Document. A request is placed on the ThumbnailRequest queue table, which is processed by an instance of CmThumbnailRequestSweep.

The system removes successfully completed thumbnail requests from the ThumbnailRequest queue table. The system also removes requests that result in managed exceptions; that is, situations where the system cannot process the request. Managed exceptions include non-existent content or source document, or attempts to overwrite a user-generated thumbnail.

For failed requests that are fixable by an administrator, the system retries the requests up to the value set on the MaximumFailures property of the CmThumbnailRequestSweep instance (the default is six retries). If all of the retries fail, the requests remain in the queue table. A CmThumbnailRequest object includes properties for retrieving status and failure information, and for restarting retries.

Metadata

Auditable: false
AllowsInstances: true
AllowsSubClasses: true
ClassDefinitionName: CmQueueEntryClassDefinition
IsDependent: false
IsHidden: false
Name: Id
Searchable: true
StorageType: ObjectStore
SuperclassName: CmAbstractQueueEntry

See Also:

Thumbnail Concepts

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.Integer	get_ElementSequenceNumber() Returns the value of the ElementSequenceNumber property.
Document	get_InputDocument() Returns the value of the InputDocument property.
void	set_ElementSequenceNumber(java.lang.Integer value) Sets the value of the ElementSequenceNumber property.
void	set_InputDocument(Document value) Sets the value of the InputDocument property.

Methods inherited from interface com.filenet.api.admin.CmAbstractQueueEntry

changeClass, get_Creator, get_DateCreated, get_DateLastModified, get_FailureCount, get_HeldUntilDate, get_Id, get_LastFailureReason, get_LastModifier, get_LeaseHolderId, get_QueueEntryStatus, set_Creator, set_DateCreated, set_DateLastModified, set_FailureCount, set_LastModifier

Methods inherited from interface com.filenet.api.core.RepositoryObject

getObjectStore

Methods inherited from interface com.filenet.api.core.IndependentlyPersistableObject

addPendingAction, clearPendingActions, delete, getAccessAllowed, getPendingActions, getUpdateSequenceNumber, isCurrent, save, save, setUpdateSequenceNumber

Methods inherited from interface com.filenet.api.core.IndependentObject

fetchProperties, fetchProperties, fetchProperty, fetchProperty, getObjectReference, refresh, refresh, refresh

Methods inherited from interface com.filenet.api.core.EngineObject

get_ClassDescription, getClassName, getConnection, getProperties, getSuperClasses

Method Detail

get_InputDocument

Document get_InputDocument()

Returns the value of the InputDocument property. For more information, see InputDocument Property.

set_InputDocument

void set_InputDocument(Document value)

Sets the value of the InputDocument property. For more information, see InputDocument Property.

get_ElementSequenceNumber

java.lang.Integer get_ElementSequenceNumber()

Returns the value of the ElementSequenceNumber property. For more information, see ElementSequenceNumber Property.

set_ElementSequenceNumber

void set_ElementSequenceNumber(java.lang.Integer value)

Sets the value of the ElementSequenceNumber property. For more information, see ElementSequenceNumber Property.