Package com.ptc.qualitymanagement.regmstr

Interface RegulatorySubmissionService

@RemoteInterface public interface RegulatorySubmissionService
The intent of the Regulatory Submission service is to handle service calls for the Regulatory Master Module

Supported API: true

Extendable: false
See Also:

  • Method Details

    • createFollowup

      RegulatorySubmission createFollowup(RegulatorySubmission submission) throws WTException, WTPropertyVetoException, PropertyVetoException
      Create a followup by Iterating the submission. This method throws an exception when a RegSubmission2 is passed as the submission parameter Instead RegSubmission2 objects should be revised

      Supported API: true
      Parameters:
      submission -
      Returns:
      Throws:
      WTException
      WTPropertyVetoException
      PropertyVetoException

    • getSubjectsForRegulatorySubmission

      WTList getSubjectsForRegulatorySubmission(RegulatorySubmission regulatorySubmission) throws WTException
      Returns list of Subjects associated with the regulatory submission

      Supported API: true
      Parameters:
      regulatorySubmission -
      Returns:
      Throws:
      WTException

    • storeSubject

      SubjectLink storeSubject(RegulatorySubmission regulatorySubmission, WTObject theObject, boolean enforceAssociationRules) throws WTException
      Stores a Subject link between a Regulatory Submission and a WT object.

      If the link already exists the existing subjectLink will be returned. If the link doesn't exist a new Subject will be created and returned.



      Supported API: true

      Parameters:
      regulatorySubmission -
      enforceAssociationRules -
      subject -
      Returns:
      Throws:
      WTException

    • storeSubject

      SubjectLink storeSubject(RegulatorySubmission regulatorySubmission, WTObject subject) throws WTException
      Stores a Subject link between a Regulatory Submission and a WT object.

      If the link already exists the existing subjectLink will be returned. If the link doesn't exist a new Subject will be created and returned.

      This method will call storeSubject(RegulatorySubmission regulatorySubmission, WTObject theObject, boolean enforceAssociationRules) setting enforceAssociationRules to true

      Supported API: true

      Parameters:
      regulatorySubmission -
      subject -
      Returns:
      Throws:
      WTException

    • deleteSubject

      SubjectLink deleteSubject(RegulatorySubmission regulatorySubmission, WTObject theObject, boolean enforceAssociationRules) throws WTException, WTPropertyVetoException
      Deletes a SubjectLink.

      If theObject is Iterable, search for links to any iteration of the version of theObject.

      Return null if no link is found.

      Supported API: true

      Parameters:
      regulatorySubmission -
      theObject -
      enforceAssociationRules -
      Returns:
      Throws:
      WTException
      WTPropertyVetoException

    • deleteSubject

      SubjectLink deleteSubject(RegulatorySubmission regulatorySubmission, WTObject theObject) throws WTException, WTPropertyVetoException
      Deletes a SubjectLink.

      If theObject is Iterable, search for links to any iteration of the version of theObject.

      Return null if no link is found. This method will call deleteSubject(RegulatorySubmission regulatorySubmission, WTObject theObject, boolean enforceAssociationRules) setting enforceAssociationRules to true

      Supported API: true

      Parameters:
      regulatorySubmission -
      theObject -
      Returns:
      Throws:
      WTException
      WTPropertyVetoException

    • getDriversForRegulatorySubmission

      WTList getDriversForRegulatorySubmission(RegulatorySubmission regulatorySubmission) throws WTException
      Returns list of Drivers associated with the regulatory submission

      Supported API: true
      Parameters:
      regulatorySubmission -
      Returns:
      Throws:
      WTException

    • storeDriver

      DriverLink storeDriver(RegulatorySubmission regulatorySubmission, WTObject Driver) throws WTException
      Stores a Driver link between a Regulatory Submission and a WT object.

      If the link already exists the existing DriverLink will be returned. If the link doesn't exist a new Driver will be created and returned.

      This method calls storeDriver(RegulatorySubmission regulatorySubmission, WTObject theObject, boolean enforceAssociationRules) setting enforceAssociationRules to true

      Supported API: true

      Parameters:
      regulatorySubmission -
      Driver -
      Returns:
      Throws:
      WTException

    • storeDriver

      DriverLink storeDriver(RegulatorySubmission regulatorySubmission, WTObject theObject, boolean enforceAssociationRules) throws WTException
      Stores a Driver link between a Regulatory Submission and a WT object.

      If the link already exists the existing DriverLink will be returned. If the link doesn't exist a new Driver will be created and returned.



      Supported API: true

      Parameters:
      regulatorySubmission -
      enforceAssociationRules -
      Driver -
      Returns:
      Throws:
      WTException

    • deleteDriver

      DriverLink deleteDriver(RegulatorySubmission regulatorySubmission, WTObject theObject, boolean enforceAssociationRules) throws WTException, WTPropertyVetoException
      Deletes a DriverLink.

      Return null if no link is found.

      Supported API: true

      Parameters:
      regulatorySubmission -
      theObject -
      enforceAssociationRules -
      Returns:
      Throws:
      WTException
      WTPropertyVetoException

    • deleteDriver

      DriverLink deleteDriver(RegulatorySubmission regulatorySubmission, WTObject theObject) throws WTException, WTPropertyVetoException
      Deletes a DriverLink.

      Return null if no link is found. This method will call deleteDriver(RegulatorySubmission regulatorySubmission, WTObject theObject, boolean enforceAssociationRules) setting enforceAssociationRules to true

      Supported API: true

      Parameters:
      regulatorySubmission -
      theObject -
      Returns:
      Throws:
      WTException
      WTPropertyVetoException

    • createRegSubmission

      RegulatorySubmission createRegSubmission(String subType, String name, String number, com.ptc.qualitymanagement.masterdata.entity.MDEntity agency, WTContainer container, Set<WTObject> drivers, Set<WTObject> subjects, List<TableData> tableData) throws WTException
      This API creates and persists a new regulatory submission, also allows for the immediate storage of subjects invalid input: '&' drivers with association rules enforced.

      - Provided 'subType' should be the full name of the regulatory submission type, example: "com.ptc.qualitymanagement.regmstr.AdverseEventRegulatorySubmission|org.rnd.CEMProxyCreatorAERTestType"
      - Provided 'agency' is used at the Regulatory Submission's "Submitted To" agency.
      - Provided container will be the holding container for the Regulatory Submission and is used to fill the Regulatory Submission's foldering information.
      - Provided 'drivers' invalid input: '&' 'subjects' will store driver invalid input: '&' subject links respectively invalid input: '&' association rules are enforced.
      Supported API: true
      Parameters:
      subType - - String - Regulatory Submission's type
      name - - String - Regulatory Submission's name
      number - - String - Regulatory Submission's number
      agency - - MDEntity - Regulatory Submission's "Submitted To" agency
      container - - WTContainer - Regulatory Submission's container
      drivers - - Set - Drivers for the Regulatory Submission
      subjects - - Set - Subjects for the Regulatory Submission
      tableData - - List - Table Data for the Regulatory Submission
      Returns:
      RegulatorySubmission - created RegulatorySubmission object
      Throws:
      WTException

    • modifyRegulatorySubmission

      RegulatorySubmission modifyRegulatorySubmission(RegulatorySubmission regulatorySubmission, Map<String,Object> values) throws WTException
      Modifies the the regulatory submission with the provided values using the PersistableAdapter. Will iterate the regulatory submission if it is not already checked out and is revisable using the ConditionalCheckoutRunner.

      Supported API: true
      Parameters:
      regulatorySubmission - the object to modify.
      values - the values to modify.
      Returns:
      the modified object.
      Throws:
      WTException - See PersistableAdapter.apply() for details.
      See Also:

    • saveAcknowledgementMessage

      RegulatorySubmission saveAcknowledgementMessage(RegulatorySubmission regulatorySubmission, String ackMessage, String ackCode) throws WTException
      Saves a list of AcknowledgementMessages. Will iterate the regulatory submission if it is not already checked out and is revisable using the ConditionalCheckoutRunner.

      Supported API: true
      Parameters:
      regulatorySubmission - the object to modify.
      ackMessage - the value for the ackMessage attribute.
      ackCode - the value for the ackCode attribute
      Returns:
      the modified object.
      Throws:
      WTException - See PersistableAdapter.apply() for details.
      See Also:

    • saveAcknowledgementMessage

      RegulatorySubmission saveAcknowledgementMessage(RegulatorySubmission regulatorySubmission, ArrayList<AcknowledgementMessageBean> ackMessages) throws WTException
      Saves a list of AcknowledgementMessages. Will iterate the regulatory submission if it is not already checked out and is revisable using the ConditionalCheckoutRunner.

      Supported API: true
      Parameters:
      regulatorySubmission - the object to modify.
      ackMessages - An ArrayList containing one or more AcknowledgementMessageBean objects.
      Returns:
      the modified object.
      Throws:
      WTException
      See Also:

    • getAcknowledgementMessages

      WTList getAcknowledgementMessages(RegulatorySubmission regulatorySubmission) throws WTException
      Returns a list of AcknowledgementMessages associated with a Regulatory Submission.

      Supported API: true
      Parameters:
      regulatorySubmission -
      Returns:
      the List of AcknowledgementMessage
      Throws:
      WTException

    • deleteAcknowledgementMessages

      RegulatorySubmission deleteAcknowledgementMessages(RegulatorySubmission regulatorySubmission) throws WTException
      Deletes the AcknowledgementMessages related to the RegulatorySubmission.

      Source AcknowledgementMessages are found using getAcknowledgementMessages() for the source object.

      Supported API: true

      Parameters:
      regulatorySubmission -
      Returns:
      the updated RegulatorySubmission
      Throws:
      WTException