Package com.ptc.qualitymanagement.regmstr.impl

Class AbstractRegulatorySubmissionProcessor

java.lang.Object

com.ptc.qualitymanagement.regmstr.impl.AbstractRegulatorySubmissionProcessor

All Implemented Interfaces:

RegulatorySubmissionProcessorInterface

Direct Known Subclasses:

AbstractRegSubmission2Processor, RegulatorySubmission2Processor, SimpleRegulatorySubmissionProcessor

public class AbstractRegulatorySubmissionProcessor
extends Object
implements RegulatorySubmissionProcessorInterface

Provides default implementations for generic features required by all regulatory submissions. Many method will need to overridden to provide agency implementations.

Generally this class should not be directly extended instead, extend the five child classes of this class.

It is an anti-pattern to have switch or if statement based up the type of the RegulatorySubmission in this class. Instead, implement the type specific code in the correct child class.

Not all methods will have generic implementations that apply to all regulatory submission types. In some cases, a "demo" implementation should be implemented here for demo purposes. These methods should have javadoc indicating that they contain demo code. All methods need detailed javadoc describing what they do so customizations can understand if they need the behavior changed.

Supported API: true

Extendable: true

See Also:

• RegulatorySubmissionProcessorInterface

Method Summary

Modifier and Type	Method	Description
RegulatorySubmission	cleanTransmissionContent(RegulatorySubmission regulatorySubmission)	Default implementation using getRegulatoryContentCategoriesToClean() to determine Regulatory Content Types to be deleted Used to Delete Regulatory Content created by the submitting process.
String	createCustomEditUrl(RegulatorySubmission regulatorySubmission)	Supported API: true
void	createPopulate(RegulatorySubmission regulatorySubmission)	Supported API: true
boolean	enableCustomEditAction()	Supported API: true
RegulatorySubmission	generatePayload(RegulatorySubmission regulatorySubmission)	Sample implementation of a payload generation process.
RegulatorySubmission	generatePrimaryContent(RegulatorySubmission regulatorySubmission)	Supported API: true
com.ptc.qualitymanagement.regmstr.SubmissionStage	getCompleteStage()	Provides the Regulatory Submission Stage for Complete Supported API: true
com.ptc.qualitymanagement.regmstr.SubmissionStage	getHistoryStage()	Provides the Regulatory Submission Stage for History Supported API: true
RegulatoryContentCategory[]	getRegulatoryContentCategoriesToClean(RegulatorySubmission regulatorySubmission)	Provides the Regulatory Content Types to be deleted by cleanTransmissionContent().
RegulatorySubmission	postComplete(RegulatorySubmission regulatorySubmission)	Default implementation using getCompleteStage() to determine the Regulatory Submission Stage attribute which is set on the Regulatory Submission, and using getHistoryStage() to determine the Regulatory Submission Stage which is set on the predecessor Regulatory Submission (If one exists).
void	preCreatePopulate(RegulatorySubmission regulatorySubmission)	Supported API: true
boolean	processAcknowledgement(String transmissionName, String transmissionContent)	Sample implementation with a two phase acknowledgment.
void	revisePopulateNewVersion(RegulatorySubmission regulatorySubmission)	Supported API: true
void	revisePopulatePreNewVersion(RegulatorySubmission regulatorySubmission)	Supported API: true

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

revisePopulatePreNewVersion

public void revisePopulatePreNewVersion(RegulatorySubmission regulatorySubmission)
                                 throws Exception

Supported API: true

Specified by:

revisePopulatePreNewVersion in interface RegulatorySubmissionProcessorInterface

Throws:

Exception

revisePopulateNewVersion

public void revisePopulateNewVersion(RegulatorySubmission regulatorySubmission)
                              throws Exception

Supported API: true

Specified by:

revisePopulateNewVersion in interface RegulatorySubmissionProcessorInterface

Throws:

Exception

preCreatePopulate

public void preCreatePopulate(RegulatorySubmission regulatorySubmission)
                       throws Exception

Supported API: true

Specified by:

preCreatePopulate in interface RegulatorySubmissionProcessorInterface

Throws:

Exception

createPopulate

public void createPopulate(RegulatorySubmission regulatorySubmission)
                    throws Exception

Supported API: true

Specified by:

createPopulate in interface RegulatorySubmissionProcessorInterface

Throws:

Exception

enableCustomEditAction

public boolean enableCustomEditAction()

Supported API: true

Specified by:

enableCustomEditAction in interface RegulatorySubmissionProcessorInterface

createCustomEditUrl

public String createCustomEditUrl(RegulatorySubmission regulatorySubmission)

Supported API: true

Specified by:

createCustomEditUrl in interface RegulatorySubmissionProcessorInterface

generatePrimaryContent

public RegulatorySubmission generatePrimaryContent(RegulatorySubmission regulatorySubmission)
                                            throws Exception

Supported API: true

Specified by:

generatePrimaryContent in interface RegulatorySubmissionProcessorInterface

Throws:

Exception

See Also:

• RegulatoryContentService.storePrimaryContent(RegulatorySubmission, InputStream, String)

processAcknowledgement

public boolean processAcknowledgement(String transmissionName,
 String transmissionContent)
                               throws Exception

Sample implementation with a two phase acknowledgment.

Ack1 contains the type name, number and remote identifier of the Regulatory Submission.

 
 {
    "ackNumber": 1,
    "typeName": "<typeName>"
    "name": "<regulatorySubmissionName>",
    "number": "<regulatorySubmissionNumber>",
    "remoteIdentifier": "<remoteIdentifier>"
 }
 

Ack2 contains the remote identifier from Ack1, the type name, the certificate number and the result.

 
 {
    "ackNumber": 2,
    "typeName": "<typeName>"
    "remoteIdentifier": "<remoteIdentifier>"
    "certificationNumber": "<certificateNumber>"
    "expirationDate": "<expirationDate>"
    "result": "SUCCESS|FAILURE"
 }
 

Per interface documentation, the acknowledgment events are only dispatched when Ack2 is received. The type name is included as this is a sample generic acknowledgment processor. In production code the type name is known because there is a one-to-one relationship between RegulatorySubmissionProcessor and the type it is registered against.

ConditionalCheckoutRunner is used to prevent multiple iterations when multiple service calls are made that perform auto checkout.

Supported API: true

Specified by:

processAcknowledgement in interface RegulatorySubmissionProcessorInterface

Returns:

Throws:

Exception

cleanTransmissionContent

public RegulatorySubmission cleanTransmissionContent(RegulatorySubmission regulatorySubmission)
                                              throws Exception

Default implementation using getRegulatoryContentCategoriesToClean() to determine Regulatory Content Types to be deleted Used to Delete Regulatory Content created by the submitting process. Transmission Regulatory Content must be cleaned because exceptions are thrown when attempting to overwrite existing Regulatory Content. Cleaning is required due to the loop back in Regulatory Submission Submitting Workflow when asked to resubmit.
Supported API: true

Specified by:

cleanTransmissionContent in interface RegulatorySubmissionProcessorInterface

Parameters:

regulatorySubmission -

Returns:

RegulatorySubmission

Throws:

Exception

postComplete

public RegulatorySubmission postComplete(RegulatorySubmission regulatorySubmission)
                                  throws Exception

Default implementation using getCompleteStage() to determine the Regulatory Submission Stage attribute which is set on the Regulatory Submission, and using getHistoryStage() to determine the Regulatory Submission Stage which is set on the predecessor Regulatory Submission (If one exists). Used to Perform work required after a successful acknowledgment from the Regulatory Agency.
Supported API: true

Specified by:

postComplete in interface RegulatorySubmissionProcessorInterface

Parameters:

regulatorySubmission -

Returns:

RegulatorySubmission

Throws:

Exception

getRegulatoryContentCategoriesToClean

public RegulatoryContentCategory[] getRegulatoryContentCategoriesToClean(RegulatorySubmission regulatorySubmission)

Provides the Regulatory Content Types to be deleted by cleanTransmissionContent(). Default vales: REGULATORY_SUBMISSION_PAYLOAD, ACKNOWLEDGEMENT1, ACKNOWLEDGEMENT2, ACKNOWLEDGEMENT3.

Supported API: true

Parameters:

regulatorySubmission -

Returns:

RegulatoryContentCategory[]

getCompleteStage

public com.ptc.qualitymanagement.regmstr.SubmissionStage getCompleteStage()

Provides the Regulatory Submission Stage for Complete

Supported API: true

Returns:

SubmissionStage - Configured Complete Stage

getHistoryStage

public com.ptc.qualitymanagement.regmstr.SubmissionStage getHistoryStage()

Provides the Regulatory Submission Stage for History

Supported API: true

Returns:

SubmissionStage - Configured History Stage

generatePayload

public RegulatorySubmission generatePayload(RegulatorySubmission regulatorySubmission)
                                     throws Exception

Sample implementation of a payload generation process.

A regulatory submission object is provided as a parameter.

Modify permissions are checked.

The TransactionRunner wrapper class is used to start a transaction (and eventually return the updated regulatory submission.

From the given submission, a JSON Object is created with some selected attributes as key/values.

A JSONArray list of strings is added to the JSON Object to demonstrate list capabilities.

The stringified version of the JSON object is then turned into a ByteArrayInputStream and file description defined.

Using the ConditionalAutoCheckoutRunner wrapper class, to ensure the regulatory submission object is checked-out and checked-in, the file is saved using the ByteArrayInputStream, description, and the RegulatoryContentCategory.REGULATORY_SUBMISSION_PAYLOAD content category. Also, the submissionID attribute is updated on the regulatory submission.

Finally, the regulatory submission object is then returned by the ConditionalAutoCheckoutRunner and TransactionRunner.

Supported API: true

Specified by:

generatePayload in interface RegulatorySubmissionProcessorInterface

Returns:

RegulatorySubmission

Throws:

Exception