Package com.ptc.qualitymanagement.regmstr.impl

Interface RegulatoryTransmissionDelegateInterface

All Known Implementing Classes:
AbstractTransmissionDelegate, AzureDropTransmissionDelegate, com.ptc.qualitymanagement.regmstr.impl.ContentWriterTransmissionDelegate, FileDropTransmissionDelegate
public interface RegulatoryTransmissionDelegateInterface
This interface defines API's to Initialize and Transmit Regulatory Information and must be implemented by all classes configured as Transmission Delegates

Supported API: true

Extendable: true

  • Method Summary

    Modifier and Type
    Method
    Description
    InputStream
    getPayloadStream(RegulatorySubmission regulatorySubmission, org.apache.logging.log4j.Logger tranmissionLogger)
    Provides the input stream to the transmit() method.
    void
    initialize()
    This method initializes all information needed for the implementation of a Transmission Delegate.
    boolean
    transmit(RegulatorySubmission regulatorySubmission)
    This method performs the transmission of a Payload to a Regulatory Agency.

  • Method Details

    • initialize

      void initialize() throws Exception
      This method initializes all information needed for the implementation of a Transmission Delegate. This method can be overwritten to achieve customization when you are extending this class.


      Supported API: true

      Throws:
      Exception

    • getPayloadStream

      InputStream getPayloadStream(RegulatorySubmission regulatorySubmission, org.apache.logging.log4j.Logger tranmissionLogger) throws WTException, PropertyVetoException
      Provides the input stream to the transmit() method. This stream is used to transmit the payload per the transmission delegate algorithm. This method can be overwritten to get the payload stream from any location.

      Any logging should be done using the parameter transmission logger. The logger is passed from the transmit() method so that all transmit logging can be in a single file.

      Do not modify the Regulatory Submission in any implementation of this method. Modification of the Regulatory Submission after transmission can be achieved by overriding RegulatorySubmissionProcessorInterface.postSubmissionProcessing(RegulatorySubmission)


      Supported API: true

      Parameters:
      regulatorySubmission -
      tranmissionLogger -
      Returns:
      Throws:
      WTException
      PropertyVetoException

    • transmit

      boolean transmit(RegulatorySubmission regulatorySubmission) throws Exception
      This method performs the transmission of a Payload to a Regulatory Agency. This method can be overwritten to achieve customization when you are extending this class.

      Do not modify the Regulatory Submission in any implementation of this method. Modification of the Regulatory Submission after transmission can be achieved by overriding RegulatorySubmissionProcessorInterface.postSubmissionProcessing(RegulatorySubmission)


      Supported API: true

      Throws:
      Exception