Content Engine Java API: com.filenet.api.sweep

Interface Summary
Interface	Description
CmAbstractSearchResult	The abstract, base class from which you create a subclass to define the class of objects that are returned in a background search result.
CmBackgroundSearch	The base class from which you can create a subclass to define the search expression and parameters for a background search.
CmBulkMoveContentJob	Represents a background task that moves content from one storage area to another.
CmContentBackoutQueueEntry	Represents the information needed for a `CmContentBackoutQueueSweep` to back out content abandoned during upload to an advanced storage area.
CmContentBackoutQueueSweep	Represents a queue sweep that processes content backout queue entries in the advanced storage areas of an object store.
CmContentDeletionQueueEntry	Represents the information needed for a `CmContentDeletionQueueSweep` to delete content from an advanced storage area.
CmContentDeletionQueueSweep	Represents a queue sweep that processes content deletion queue entries in the advanced storage areas of an object store.
CmContentMigrationPolicy	Represents a background task that moves content from one storage area to another.
CmContentReplicationQueueEntry	Represents the information needed for a `CmContentReplicationQueueSweep` to replicate content within an advanced storage area.
CmContentReplicationQueueSweep	Represents a queue sweep that processes content replication queue entries within an advanced storage area of an object store.
CmCustomQueueSweep	Represents a background task that operates continuously, periodically sweeping over a queue table specified as a target class.
CmCustomSweepJob	Represents a background task that performs a one-time sweep over a specified target class and retrieves instances that meet the criteria set on the job's filter expression.
CmCustomSweepPolicy	Represents a background task that performs an indefinite number of sweeps over a specified target class and retrieves instances that meet the criteria set on the policy's filter expression.
CmDisposalPolicy	Defines criteria for objects of a specified class to be disposed by a policy controlled sweep.
CmJobSweepResult	Defines a result record generated by a sweep job.
CmPolicyControlledSweep	Represents a background service that repeatedly visits all instances of a specified class residing in a single database table.
CmPolicySweepResult	Defines a result record generated by a sweep policy.
CmQueueSweep	Abstract base class for sweep instances that are optimized for ongoing processing of queue tables.
CmRetentionUpdateJob	Represents a background task that updates the retention date on objects that support it.
CmRetentionUpdatePolicy	Defines criteria for updating the retention period for objects of a specified class by a policy controlled sweep.
CmSweep	An abstract base class for an object that represents a background service that visits all instances of a specified class.
CmSweepAction	Defines the action to be taken when a custom sweep (`CmCustomSweepJob`, `CmCustomSweepPolicy`, or `CmCustomQueueSweep`) is invoked.
CmSweepConfiguration	Represents global configuration data for the sweep framework.
CmSweepJob	Abstract base class for a sweep that visits each instance of the specified class exactly once.
CmSweepPolicy	Abstract base class for objects that specify rules for a policy controlled sweep, represented by a `CmPolicyControlledSweep` object.
CmSweepPolicyRelationship	Concrete subclass that defines an association between a `CmPolicyControlledSweep` and a `CmSweepPolicy`, as set in the Sweep property and the SweepSubscriber property, respectively.
CmSweepRelationship	Abstract base class for objects that define an association between a policy controlled sweep and a sweep policy.
CmSweepResult	Represents a result record for an object selected by a sweep.
CmThumbnailGenerationJob	Represents a background task that initiates sweep-based document thumbnail generation.
CmThumbnailRequest	Represents a request to generate a thumbnail image for a `ContentElement` of a `Document`.
CmThumbnailRequestSweep	Defines the format, size, and color parameters that are used by the thumbnail generation service to render document thumbnails.

Package com.filenet.api.sweep Description

Provides classes and interfaces for the sweep framework, a background service that visits a specified class and processes the instances that meet a specified criteria. The framework provides implementations for sweep jobs, queue table sweeps, and policy-controlled sweeps.