Package com.ptc.windchill.sync.wpsync

Interface WPSyncService

All Known Implementing Classes:
StandardWPSyncService
@RemoteInterface public interface WPSyncService
This class WPSyncService represents the client accessible API to the WPSync.

Supported API: true

Extendable: false

  • Method Details

    • getExportStatus

      String getExportStatus(ObjectReference obj) throws WTException
      This API give you a current status of export process

      Supported API: true.
      Parameters:
      obj - the obj
      Returns:
      String
      Throws:
      WTException - the wT exception

    • performExportProcess

      boolean performExportProcess(ObjectReference objRef) throws WTException


      Supported API: true.
      Parameters:
      objRef - the obj ref
      Returns:
      boolean
      Throws:
      WTException - the wT exception

    • performExportProcess

      boolean performExportProcess(ObjectReference refDeliveryRecord, WTContainerRef refContainer) throws WTException
      Initiates an export for the passed in delivery record. The container parameter can be used to specify the context for which the export was performed. This will be used to record an 'Exported From Context' value for the delivery when zipped for auditing purposes. This is optional, and if not specified, the container of the delivery record will be considered the context of the export.

      Supported API: true

      Parameters:
      refDeliveryRecord - reference to the delivery record being exported
      refContainer - reference to container to record as the context for the export; may be null
      Returns:
      true if export process initiated successfully; false if not
      Throws:
      WTException

    • performExport

      boolean performExport(ObjectReference obj) throws WTException


      Supported API: true.
      Parameters:
      obj - the obj
      Returns:
      boolean
      Throws:
      WTException - the wT exception

    • abortExport

      boolean abortExport(ObjectReference objRef) throws WTException


      Supported API: true.
      Parameters:
      objRef - the obj ref
      Returns:
      boolean
      Throws:
      WTException - the wT exception