Interface DeliveryExportDelegate

All Known Implementing Classes:
AbstractDeliveryExportDelegate

public interface DeliveryExportDelegate
A delegate used for package delivery export format-specific behavior.

Supported API: true
Extendable: false

  • Method Details

    • buildExportFiles

      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)
      setSentFrom(WTUser)
      In general this should be set to SessionHelper.getPrincipal() 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

      Parameters:
      deliveryRecord - DeliveryRecord being exported
      Returns:
      delivery export result containing information about the export and export files
      Throws:
      WTException - to be handled by caller
    • getPackageExportGraph

      PackageExportGraph getPackageExportGraph(DeliveryRecord delivery) throws WTException
      Returns instance of PackageExportGraph for passed in delivery record.



      Supported API: true


      Extendable: false.

      Parameters:
      delivery - the delivery
      Returns:
      package export graph
      Throws:
      WTException - to be handled by caller
    • getPackageExportGraph

      PackageExportGraph getPackageExportGraph(DeliveryRecord delivery, boolean bApplyFilters) throws WTException
      Returns instance of PackageExportGraph for passed in delivery record. The second flag determines if member access filters should be applied.



      Supported API: true


      Extendable: false.

      Parameters:
      delivery - the delivery
      bApplyFilters - determines if member access filters should be applied
      Returns:
      package export graph
      Throws:
      WTException - to be handled by caller