Package com.ptc.windchill.sync.wpsync

Interface PackageExportQueueDelegate

All Known Implementing Classes:
DefaultPackageExportQueueDelegate, FBRPackageExportQueueDelegate
public interface PackageExportQueueDelegate
Delegate for managing multiple export queues for package export background jobs.

On startup, the method createQueues will be called to create the processing queues as specified by the property com.ptc.windchill.wp.delivery.export.numExportQueues to be utilized for processing package export tasks in background.

When a package export is performed, the method getQueueName will be called to request the least busy queue to place the package export task on for the Delivery Record instance. A site may define their own implementation of this method for more sophisticated queue handling.

Supported API: true Extendable: false

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    createQueues()
    Creates the queues which will process background package export.
    String
    getQueueName()
    Returns the name of the preferred queue to assign the Delivery Record export task to.

  • Method Details

    • createQueues

      void createQueues() throws WTException
      Creates the queues which will process background package export. This will be called on system startup to create a number of queues as specified with com.ptc.windchill.wp.delivery.export.numExportQueues property.

      Supported API: true

      Throws:
      WTException

    • getQueueName

      String getQueueName() throws WTException
      Returns the name of the preferred queue to assign the Delivery Record export task to. The out-of-the-box implementation will return the least busy queue. Supported API: true
      Returns:
      name of queue which would be preferred for assigning export package task to.
      Throws:
      WTException