Package com.ptc.qualitymanagement.regmstr.impl

Class RegulatorySubmissionProcessorHelper

java.lang.Object
com.ptc.qualitymanagement.regmstr.impl.RegulatorySubmissionProcessorHelper
public class RegulatorySubmissionProcessorHelper extends Object
Methods to assist with customizing Regulatory Submission Processing.

Supported API: true

Extendable: false

  • Method Details

    • getRegulatorySubmissionProcessor

      public static RegulatorySubmissionProcessorInterface getRegulatorySubmissionProcessor(TypeIdentifier typeIdentifier) throws WTException
      Looks up the most specific implementation of the RegulatorySubmissionProcessorInterface based upon the parameter. If a specific implementation for the Type of regulatorySubmission is not found, parent types are searched recursively until an implementation is found.

      Implementations of RegulatorySubmissionProcessorInterface should always be created this way. It is an anti-pattern to call new ().

      Supported API: true

      Parameters:
      typeIdentifier - the Regulatory Submission's type identifier
      Returns:
      the most specific implementation based upon the Regulatory Submission
      Throws:
      WTException - if a registered RegulatorySubmissionProcessorInterface data populator in service xconf for given Regulatory Submission type could not be found

    • getRegulatorySubmissionProcessor

      public static RegulatorySubmissionProcessorInterface getRegulatorySubmissionProcessor(RegulatorySubmission regulatorySubmission) throws WTException
      Looks up the most specific implementation of the RegulatorySubmissionProcessorInterface based upon the parameter. If a specific implementation for the Type of regulatorySubmission is not found, parent types are searched recursively until an implementation is found.

      Implementations of RegulatorySubmissionProcessorInterface should always be created this way. It is an anti-pattern to call new ().

      Supported API: true

      Parameters:
      regulatorySubmission - the Regulatory Submission
      Returns:
      the most specific implementation based upon the Regulatory Submission
      Throws:
      WTException - if a registered RegulatorySubmissionProcessorInterface data populator in service xconf for given Regulatory Submission type could not be found

    • generatePayload

      public static RegulatorySubmission generatePayload(RegulatorySubmission regulatorySubmission) throws Exception
      Executes the implementation of RegulatorySubmissionProcessorInterface.generatePayload(RegulatorySubmission) registered to the provided Regulatory Submission's type
      Supported API: true

      Parameters:
      regulatorySubmission -
      Returns:
      Throws:
      Exception

    • cleanTransmissionContent

      public static RegulatorySubmission cleanTransmissionContent(RegulatorySubmission regulatorySubmission) throws Exception
      Executes the implementation of RegulatorySubmissionProcessorInterface.cleanTransmissionContent(RegulatorySubmission) registered to the provided Regualtory Submission's type
      Supported API: true

      Parameters:
      regulatorySubmission -
      Returns:
      Throws:
      Exception

    • submitRegulatorySubmission

      public static RegulatorySubmission submitRegulatorySubmission(RegulatorySubmission regulatorySubmission) throws Exception
      Executes the implementation of RegulatorySubmissionProcessorInterface.submitRegulatorySubmission(RegulatorySubmission) registered to the provided Regualtory Submission's type
      Supported API: true

      Parameters:
      regulatorySubmission -
      Returns:
      Throws:
      Exception

    • isSameVersionOfSameObject

      public static boolean isSameVersionOfSameObject(Persistable a, Persistable b)
      Verifies if two Persistable objects are the same version of the same object
      Supported API: true

      Parameters:
      a -
      b -
      Returns:

    • getLatestRevisions

      public static WTCollection getLatestRevisions(WTCollection source) throws WTException
      Returns a sub collection of latest revisions of the provided source object collection
      Supported API: true

      Parameters:
      source -
      Returns:
      Throws:
      WTException

    • postComplete

      public static RegulatorySubmission postComplete(RegulatorySubmission regulatorySubmission) throws Exception
      Executes the implementation of RegulatorySubmissionProcessorInterface.postComplete(RegulatorySubmission) registered to the provided Regulatory Submission's type
      Supported API: true

      Parameters:
      regulatorySubmission -
      Returns:
      Throws:
      Exception

    • postCancellation

      public static RegulatorySubmission postCancellation(RegulatorySubmission regulatorySubmission) throws Exception
      Executes the implementation of RegulatorySubmissionProcessorInterface.postCancellation(RegulatorySubmission) registered to the provided Regulatory Submission's type
      Supported API: true

      Parameters:
      regulatorySubmission -
      Returns:
      Throws:
      Exception

    • reviseRuleforAttributes

      public static void reviseRuleforAttributes(RegulatorySubmission regulatorySubmission, String preferenceKey) throws Exception
      Looks for preference setting for Tracking attributes in preference management Then applies all the rules as per the value
      Supported API: true

      Parameters:
      regulatorySubmission -
      trackingAttriPreference -
      regContentPreference -
      Throws:
      Exception

    • reviseRuleforRegContent

      public static void reviseRuleforRegContent(RegulatorySubmission regulatorySubmission, String contentKey) throws Exception
      Looks for preference setting for regulatory content in preference management Then applies all the rules as per the value
      Supported API: true

      Parameters:
      regulatorySubmission -
      contentKey -
      Throws:
      Exception

    • dispatchTransmissionStartedEvent

      public static void dispatchTransmissionStartedEvent(RegulatorySubmission regulatorySubmission) throws WTException
      Dispatch the Transmission Started event for the regulatory submission.
      Supported API: true

      Parameters:
      regulatorySubmission -
      Throws:
      WTException
      See Also:
      • invalid reference 
        com.ptc.qualitymanagement.regmstr.RegulatoryMasterServiceEvent.TRANSMISSION_STARTED

    • dispatchTransmissionDelayedEvent

      public static void dispatchTransmissionDelayedEvent(RegulatorySubmission regulatorySubmission) throws WTException
      Dispatch the Transmission Delayed event for the regulatory submission.
      Supported API: true

      Parameters:
      regulatorySubmission -
      Throws:
      WTException
      See Also:
      • invalid reference 
        com.ptc.qualitymanagement.regmstr.RegulatoryMasterServiceEvent.TRANSMISSION_DELAYED

    • dispatchTransmissionCompletedSuccessfulEvent

      public static void dispatchTransmissionCompletedSuccessfulEvent(RegulatorySubmission regulatorySubmission) throws WTException
      Dispatch the Transmission Completed Successful event for the regulatory submission.
      Supported API: true

      Parameters:
      regulatorySubmission -
      Throws:
      WTException
      See Also:
      • invalid reference 
        com.ptc.qualitymanagement.regmstr.RegulatoryMasterServiceEvent.TRANSMISSION_COMPLETED_SUCCESSFUL

    • dispatchTransmissionCompletedWithErrorsEvent

      public static void dispatchTransmissionCompletedWithErrorsEvent(RegulatorySubmission regulatorySubmission) throws WTException
      Dispatch the Transmission Completed With Errors event for the regulatory submission.
      Supported API: true

      Parameters:
      regulatorySubmission -
      Throws:
      WTException
      See Also:
      • invalid reference 
        com.ptc.qualitymanagement.regmstr.RegulatoryMasterServiceEvent.TRANSMISSION_COMPLETED_WITH_ERRORS

    • dispatchTransmissionCanceledEvent

      public static void dispatchTransmissionCanceledEvent(RegulatorySubmission regulatorySubmission) throws WTException
      Dispatch the Transmission Canceled event for the regulatory submission.
      Supported API: true

      Parameters:
      regulatorySubmission -
      Throws:
      WTException
      See Also:
      • invalid reference 
        com.ptc.qualitymanagement.regmstr.RegulatoryMasterServiceEvent.TRANSMISSION_CANCELED

    • dispatchAcknowledgmentSuccessfulEvent

      public static void dispatchAcknowledgmentSuccessfulEvent(RegulatorySubmission regulatorySubmission) throws WTException
      Dispatch the Acknowledgement Successful event for the regulatory submission.
      Supported API: true

      Parameters:
      regulatorySubmission -
      Throws:
      WTException
      See Also:
      • invalid reference 
        com.ptc.qualitymanagement.regmstr.RegulatoryMasterServiceEvent.ACKNOWLEDGEMENT_SUCCESSFUL

    • dispatchAcknowledgmentFailedEvent

      public static void dispatchAcknowledgmentFailedEvent(RegulatorySubmission regulatorySubmission) throws WTException
      Dispatch the Acknowledgement Failed event for the regulatory submission.
      Supported API: true

      Parameters:
      regulatorySubmission -
      Throws:
      WTException
      See Also:
      • invalid reference 
        com.ptc.qualitymanagement.regmstr.RegulatoryMasterServiceEvent.ACKNOWLEDGEMENT_FAILED

    • dispatchTransmissionFailedEvent

      public static void dispatchTransmissionFailedEvent(RegulatorySubmission regulatorySubmission) throws WTException
      Dispatch the Transmission Failed event for the regulatory submission.
      Supported API: true

      Parameters:
      regulatorySubmission -
      Throws:
      WTException
      See Also:
      • invalid reference 
        com.ptc.qualitymanagement.regmstr.RegulatoryMasterServiceEvent.TRANSMISSION_FAILED

    • generatePrimaryContent

      @Deprecated public static RegulatorySubmission generatePrimaryContent(RegulatorySubmission regulatorySubmission) throws Exception
      Deprecated.
      This method generates a human readable version of the data represented by the Regulatory Submission and sets it as Primary Content. Draft is set to false.
      Supported API: true

      Parameters:
      regulatorySubmission -
      Returns:
      Throws:
      Exception

    • generatePrimaryContent

      public static RegulatorySubmission generatePrimaryContent(RegulatorySubmission regulatorySubmission, boolean draft) throws Exception
      This method generates a human readable version of the data represented by the Regulatory Submission and sets it as Primary Content.
      Supported API: true

      Parameters:
      regulatorySubmission -
      Returns:
      Throws:
      Exception

    • deletePrimaryContent

      public static RegulatorySubmission deletePrimaryContent(RegulatorySubmission regulatorySubmission) throws Exception
      This method deletes the Primary Content of a Regulatory Submission.
      Supported API: true

      Parameters:
      regulatorySubmission -
      Returns:
      Throws:
      Exception