Package com.ptc.windchill.wp.delivery.export

Class AbstractDeliveryExportDelegate

java.lang.Object
com.ptc.windchill.wp.delivery.export.AbstractDeliveryExportDelegate
All Implemented Interfaces:
DeliveryExportDelegate
public abstract class AbstractDeliveryExportDelegate extends Object implements DeliveryExportDelegate
An abstract implementation of DeliveryExportDelegate designed to provide common logic across all delegates accessible via extension of this class.



Supported API: true

Extendable: true

  • Method Details

    • buildExportFiles

      public DeliveryExportResult buildExportFiles(DeliveryRecord deliveryRecord) throws WTException
      Builds export files given the passed in delivery record. The delivery record must have the following values set:
      setMyWorkPackage(WorkPackage
      setDeliveryManifest(DeliveryManifestType)
      setDeliveryMedium(DeliveryMediumType)
      setDeliveryOption(DeliveryOptionType)
      if DeliveryOptionType is not DeliveryOptionType.FULL
      then the following must also be set:
      setBase(DeliveryRecord)
      Supported API: true
      Extendable: false

      Specified by:
      buildExportFiles in interface DeliveryExportDelegate
      Parameters:
      deliveryRecord - DeliveryRecord being exported
      Returns:
      export result object, containing information about the export and export files
      Throws:
      WTException - to be handled by caller

    • getExportFileName

      public static String getExportFileName(DeliveryRecord deliveryRecord) throws WTException
      Given the passed in DeliveryRecord, this method returns the file name for the export file, which should be used 'as is' for a single chunk export or be used as the 'base' name for a multiple-chunk export. This method attempt to provide a cross-platform filename, with characters that might be unsupported on any particular platform replaced with one which is supported uniformly across all platforms.

      Parameters:
      deliveryRecord - delivery record
      Returns:
      filename for export file Supported API: true
      Throws:
      WTException - the wT exception