com.filenet.api.sweep

Interface CmThumbnailRequestSweep

All Superinterfaces:

CmQueueSweep, CmSweep, EngineObject, IndependentlyPersistableObject, IndependentObject, RepositoryObject, java.io.Serializable, Subscribable

public interface CmThumbnailRequestSweep
extends RepositoryObject, CmQueueSweep

Defines the format, size, and color parameters that are used by the thumbnail generation service to render document thumbnails. A CmThumbnailRequestSweep instance operates on the ThumbnailRequest queue table, initiating thumbnail generation for each request. A request is represented by a CmThumbnailRequest object.

A CmThumbnailRequestSweep instance is created by the Thumbnail Extensions AddOn. It is disabled by default. You cannot create additional instances of this class; there can be only one queue sweep instance for any given ThumbnailRequest queue table.

The default CmThumbnailRequestSweep instance is configured to be efficiently continuous. It runs in a wait state until it is notified that a new request is posted in the ThumbnailRequest queue table.

Important: For CmThumbnalRequestSweep, the default value of the MaximumFailures property is three, meaning that an instance of CmThumbnalRequestSweep attempts to reprocess failed thumbnail request queue entries up to three times. Entries that fail to process after three attempts are set to QueueEntryStatus.FAILED, and, as a result, CmThumbnalRequestSweep no longer attempts to process the queue entries.

To restart the processing of failed queue entries, you must reset the FailureCount property to zero on each queue entry, which automatically changes the QueueEntryStatus property from FAILED to RETRY_WAIT. To restart a large volume of failed queue entries, it is recommended that you use a custom sweep job. For more information, see Resetting failed queue sweep entries.

Metadata

Auditable: true
AllowsInstances: true
AllowsSubClasses: true
ClassDefinitionName: SubscribableClassDefinition
IsDependent: false
IsHidden: false
Name: DisplayName
Searchable: true
StorageType: ObjectStore
SuperclassName: CmQueueSweep

See Also:

Thumbnail Concepts

Method Summary

Methods

Modifier and Type	Method and Description
ThumbnailImageColor	get_ImageColor() Returns the value of the ImageColor property.
ThumbnailImageFormat	get_ImageFormat() Returns the value of the ImageFormat property.
ThumbnailImageSize	get_ImageSize() Returns the value of the ImageSize property.
void	set_ImageColor(ThumbnailImageColor value) Sets the value of the ImageColor property.
void	set_ImageFormat(ThumbnailImageFormat value) Sets the value of the ImageFormat property.
void	set_ImageSize(ThumbnailImageSize value) Sets the value of the ImageSize property.

Methods inherited from interface com.filenet.api.sweep.CmQueueSweep

get_CurrentDeferredObjectCount, get_CurrentExaminedObjectCount, get_CurrentFailedObjectCount, get_CurrentProcessedObjectCount, get_DeferredObjectCount, get_DescriptiveText, get_DisplayName, get_EffectiveEndDate, get_EffectiveStartDate, get_IsEnabled, get_MaximumFailures, get_SweepBatchSize, get_SweepRetryWaitInterval, set_DescriptiveText, set_DisplayName, set_EffectiveEndDate, set_EffectiveStartDate, set_IsEnabled, set_MaximumFailures, set_SweepBatchSize, set_SweepRetryWaitInterval

Methods inherited from interface com.filenet.api.sweep.CmSweep

get_AuditedEvents, get_Creator, get_DateCreated, get_DateLastModified, get_ExaminedObjectCount, get_FailedObjectCount, get_Id, get_InterBatchDelay, get_LastModifier, get_MaxSweepWorkers, get_Owner, get_Permissions, get_ProcessedObjectCount, get_SweepEndDate, get_SweepStartDate, get_SweepTarget, get_SweepTimeslots, set_Creator, set_DateCreated, set_DateLastModified, set_InterBatchDelay, set_LastModifier, set_MaxSweepWorkers, set_Owner, set_Permissions, set_SweepTarget, set_SweepTimeslots

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

getObjectStore

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

raiseEvent

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_ImageFormat

ThumbnailImageFormat get_ImageFormat()

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

set_ImageFormat

void set_ImageFormat(ThumbnailImageFormat value)

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

get_ImageSize

ThumbnailImageSize get_ImageSize()

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

set_ImageSize

void set_ImageSize(ThumbnailImageSize value)

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

get_ImageColor

ThumbnailImageColor get_ImageColor()

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

set_ImageColor

void set_ImageColor(ThumbnailImageColor value)

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