• Packages that use CmSweep 
    Package Description
    com.filenet.api.core
    Provides classes and interfaces that are related to the core business objects of the API, such as EntireNetwork, Domain, Document, Folder, and so on.
    com.filenet.api.engine
    Provides interfaces and classes related to EventActions and other non-FileNet code which runs within the Content Engine itself.
    com.filenet.api.sweep
    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.
    • Uses of CmSweep in com.filenet.api.core

      Methods in com.filenet.api.core that return CmSweep 
      Modifier and Type Method and Description
      static CmSweep Factory.CmSweep.fetchInstance(ObjectStore os, Id objectId, PropertyFilter filter)
      Retrieves an object of the CmSweep class by the specified object ID from the specified object store.
      static CmSweep Factory.CmSweep.getInstance(ObjectStore os, Id objectId)
      Constructs an instance of the CmSweep class from the specified object store.
    • Uses of CmSweep in com.filenet.api.engine

      Methods in com.filenet.api.engine with parameters of type CmSweep 
      Modifier and Type Method and Description
      void SweepActionHandler.onPolicySweep(CmSweep sweepObject, CmSweepPolicy sweepPolicy, SweepActionHandler.SweepItem[] sweepItems)
      Invoked when a custom sweep policy passes instances of a target class to the custom sweep handler.
      void SweepActionHandler.onSweep(CmSweep sweepObject, SweepActionHandler.SweepItem[] sweepItems)
      Invoked when a custom sweep job or queue sweep passes instances of a target class to the custom sweep handler.
    • Uses of CmSweep in com.filenet.api.sweep

      Subinterfaces of CmSweep in com.filenet.api.sweep 
      Modifier and Type Interface and Description
      interface  CmBackgroundSearch
      The base class from which you can create a subclass to define the search expression and parameters for a background search.
      interface  CmBulkMoveContentJob
      Represents a background task that moves content from one storage area to another.
      interface  CmContentBackoutQueueSweep
      Represents a queue sweep that processes content backout queue entries in the advanced storage areas of an object store.
      interface  CmContentDeletionQueueSweep
      Represents a queue sweep that processes content deletion queue entries in the advanced storage areas of an object store.
      interface  CmContentReplicationQueueSweep
      Represents a queue sweep that processes content replication queue entries within an advanced storage area of an object store.
      interface  CmCustomQueueSweep
      Represents a background task that operates continuously, periodically sweeping over a queue table specified as a target class.
      interface  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.
      interface  CmPolicyControlledSweep
      Represents a background service that repeatedly visits all instances of a specified class residing in a single database table.
      interface  CmQueueSweep
      Abstract base class for sweep instances that are optimized for ongoing processing of queue tables.
      interface  CmRetentionUpdateJob
      Represents a background task that updates the retention date on objects that support it.
      interface  CmSweepJob
      Abstract base class for a sweep that visits each instance of the specified class exactly once.
      interface  CmThumbnailGenerationJob
      Represents a background task that initiates sweep-based document thumbnail generation.
      interface  CmThumbnailRequestSweep
      Defines the format, size, and color parameters that are used by the thumbnail generation service to render document thumbnails.

© Copyright IBM Corporation 2006, 2015. All rights reserved.