com.filenet.api.sweep

Interface CmCustomQueueSweep

  • All Superinterfaces:
    CmQueueSweep, CmSweep, EngineObject, IndependentlyPersistableObject, IndependentObject, RepositoryObject, java.io.Serializable, Subscribable

    public interface CmCustomQueueSweep
extends RepositoryObject, CmQueueSweep
    Represents a background task that operates continuously, periodically sweeping over a queue table specified as a target class. The custom queue sweep passes retrieved queue objects to a user implementation of the SweepActionHandler interface, which performs a custom action on the objects. When the handler successfully processes a queue item, the sweep service automatically deletes the item from the queue table. Queue items that fail to process are automatically retried up to a configurable number of times.

    A queue sweep can only process subclass instances of CmAbstractQueueEntry. For a custom queue sweep to work, you must create a subclass of CmAbstractQueueEntry, and specify that subclass in the SweepTarget property of the custom queue sweep.

    To associate an implemented action handler with a custom queue sweep, you set a CmSweepAction on the custom queue sweep.

    A typical use case for a queued background operation is to control the flow of work to a scarce resource that is too slow to perform its operation within the context of an on-line transaction. A shared printer servicing a client application is one such case. An application that sends requests directly to the printer could back up the printer with requests. By implementing a custom queue sweep, you could manage the delivery of requests to the printer at an even rate. Instead of sending requests directly to the printer, the application would leverage the custom queue sweep, which would pass queue objects (printer requests) to a sweep action handler. The handler (and the supporting sweep service) would control the flow of requests to the printer.

    Metadata

    Auditable: true
    AllowsInstances: true
    AllowsSubClasses: true
    ClassDefinitionName: SubscribableClassDefinition
    IsDependent: false
    IsHidden: false
    Name: DisplayName
    Searchable: true
    StorageType: ObjectStore
    SuperclassName: CmQueueSweep
    See Also:
    Custom Sweeps, Action Handlers

    • Method Detail

      • changeClass

        void changeClass(java.lang.String className)
        Changes the class of a Content Engine object. The new class must already exist and both it and the original class must be subclasses of the same base class. The changeClass method does not modify the security for an object, even if the object's current security is derived from the default security for its source class. For the object's user-defined properties, the following rules apply:
        • Any user-defined properties that exist in the new class but not in the original class are set to the default value defined by the new class (or to null if there is no default defined).
        • Any user-defined properties that exist in both the original and the new class that are writable and have the same value (including null) as the default value defined in the original class will be set to the default value defined by the new class. However, any user-defined property that has had its value modified from the default value will retain that modified value in the new class.
        • Any user-defined properties whose definitions exist in the original class but not in the new class will no longer exist on the object when its class is changed.
        • Property constraints for the new class (for example, required values, choice lists, ranges) are not enforced.

        When the class of a document object is changed, the default document lifecycle policy of the new class will only be applied to the document object's DocumentLifecyclePolicy property if both of the following scenarios occur:

        • The document has no current lifecycle policy.
        • The document is either a reservation object, or is the current version object and is not reserved.

        Changing the document class of a document object has no effect on the storage location of the document's content. For more information, see the Document Storage topic in the "Document Concepts" section of the Content Engine Java and .NET API Developer's Guide.

        Parameters:
        className - A String specifying the symbolic name, ClassNames constant, ID, or GUIDConstants constant of the class to which this object is to be changed.
        Throws:
        E_NULL_OR_INVALID_PARAM_VALUE - if className is null or has a length of zero.
Skip navigation links
  • Summary: 
  • Nested | 
  • Field | 
  • Constr | 
  • Method
  • Detail: 
  • Field | 
  • Constr | 
  • Method

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