Package com.ptc.windchill.wp.delivery

Interface DeliveryService

All Known Implementing Classes:
StandardDeliveryService
@RemoteInterface public interface DeliveryService


Supported API: true

Extendable: false.

  • Method Details

    • getDeliveries

      WTSet getDeliveries(AbstractWorkPackage wp) throws WTException
      Get all the delivery records for a package.

      Supported API: true
      Parameters:
      wp - Package to retrieve deliveries for.
      Returns:
      WTSet of DeliveryRecords (guaranteed non-null, may be empty).
      Throws:
      WTException - the wT exception

    • createZip

      void createZip(DeliveryRecord deliveryRecord) throws WTException
      Creates a zip for a previously locked package.

      Supported API: true
      Parameters:
      deliveryRecord - the delivery record
      Throws:
      WTException - the wT exception

    • createZip

      void createZip(DeliveryRecord deliveryRecord, WTContainerRef refContainer) throws WTException
      Creates a zip for a previously locked package. The container parameter records the user context from which the zip operation is being performed. For shared delivery records, this should be set to the context where the delivery is actually being zipped. If no context is passed, the delivery record's container will be used as the context of the export.

      Supported API: true

      Parameters:
      deliveryRecord - the delivery record to create zip of
      refContainer - reference to context where zip action was initiated
      Throws:
      WTException

    • getDeliveredMembers

      WTSet getDeliveredMembers(DeliveryRecord delivery) throws WTException
      Returns set of package members delivered in the given delivery.

      Supported API: true.
      Parameters:
      delivery - the delivery to check for delivered members.
      Returns:
      Set of package members delivered in the given delivery. Empty set if none.
      Throws:
      WTException

    • getChangedMembersByDate

      WTSet getChangedMembersByDate(DeliveryRecord baseDelivery) throws WTException
      Returns set of package members exported in the given base delivery and have modify date later than the zip attachment associated with the base delivery. NOTE: PersistedCollectionTombstone are not included in the result.

      Supported API: true
      Parameters:
      baseDelivery - The base delivery to check for delivered members.
      Returns:
      Set of package members changed since base delivery zip creation. Empty set if none.
      Throws:
      WTException