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

Field Summary

Fields inherited from interface com.ptc.qualitymanagement.regmstr.impl.RegulatorySubmissionProcessorInterface

USE_PRIMARY_CONTENT_AS_TRANSMISSION_PAYLOAD

Method Summary

Modifier and Type	Method	Description
RegulatorySubmission	cleanTransmissionContent(RegulatorySubmission regulatorySubmission)	Default implementation using getRegulatoryContentCategoriesToClean() to determine Regulatory Content Types to be deleted.
String	createCustomEditUrl(RegulatorySubmission regulatorySubmission)	Supported API: true
void	createPopulate(RegulatorySubmission regulatorySubmission)	Supported API: true
boolean	enableCustomEditAction()	Supported API: true
RegulatorySubmission	expireRegulatorySubmission(RegulatorySubmission submission)	Default implementation: Marks the provided regulatory submission as expired, changes its SubmissionStage to expired, and fires the RegulatoryMasterServiceEvent.AUTO_EXPIRED event.
RegulatorySubmission	generatePayload(RegulatorySubmission regulatorySubmission)	Sample implementation of a payload generation process.
RegulatorySubmission	generatePrimaryContent(RegulatorySubmission regulatorySubmission)	Deprecated.
RegulatorySubmission	generatePrimaryContent(RegulatorySubmission regulatorySubmission, boolean draft)	Generates the primary content.
com.ptc.qualitymanagement.regmstr.SubmissionStage	getCancellationStage()	Provides the Regulatory Submission Stage for Cancellation 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().
com.ptc.qualitymanagement.regmstr.SubmissionStage	getSubmittedStage()	Provides the Regulatory Submission Stage for Submitted Supported API: true
RegulatoryTransmissionDelegateInterface	getTransmissionDelegate(RegulatorySubmission regulatorySubmission)	Default implementation: Returns the SimulateTransmissionDelegate if no delegate for the Type is found, Registered with this following entry: <Service name="com.ptc.qualitymanagement.regmstr.impl.RegulatoryTransmissionDelegateInterface"> <Option requestor="null" serviceClass="com.ptc.qualitymanagement.regmstr.impl.SimulateTransmissionDelegate" selector="default" cardinality="duplicate"> </Service> Supported API: true
String	getTransmissionPayloadCategory()	Returns RegulatoryContentCategory.REGULATORY_SUBMISSION_PAYLOAD.
boolean	performTrackRegSubActionValidation(RegulatorySubmission regSub2)	Default implementation: Returns False since the action isn't supported for the Simple Regulatory Submission Supported API: true
RegulatorySubmission	postCancellation(RegulatorySubmission regulatorySubmission)	Used to perform work required after the cancellation of the submission process of a regulatory submission.
RegulatorySubmission	postComplete(RegulatorySubmission regulatorySubmission)	Used to Perform work required after a successful acknowledgement from the Regulatory Agency.
RegulatorySubmission	postSubmissionProcessing(RegulatorySubmission regulatorySubmission)	Default implementation: Sets the submittedDate to the current date and sets the submissionStage to Submitted.
void	preCreatePopulate(RegulatorySubmission regulatorySubmission)	Supported API: true
ApplicationData	processAcknowledgement(String transmissionName, byte[] transmissionContent)	Sample implementation with a two phase acknowledgement.
void	revisePopulateNewVersion(RegulatorySubmission regulatorySubmission)	Supported API: true
void	revisePopulatePreNewVersion(RegulatorySubmission regulatorySubmission)	Supported API: true
RegulatorySubmission	submitRegulatorySubmission(RegulatorySubmission regulatorySubmission)	Default Implementation: Submits the Regulatory Submission using the SimulateTransmissionDelegate.

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

@Deprecated
public RegulatorySubmission generatePrimaryContent(RegulatorySubmission regulatorySubmission)
                                            throws Exception

Deprecated.

Generates the primary content with draft equal to false.

Specified by:

generatePrimaryContent in interface RegulatorySubmissionProcessorInterface

Throws:

Exception

See Also:

• RegulatoryContentService.storePrimaryContent(RegulatorySubmission, InputStream, String)

generatePrimaryContent

public RegulatorySubmission generatePrimaryContent(RegulatorySubmission regulatorySubmission,
 boolean draft)
                                            throws Exception

Generates the primary content.

Supported API: true

Specified by:

generatePrimaryContent in interface RegulatorySubmissionProcessorInterface

Throws:

Exception

See Also:

• Supported API: true


processAcknowledgement

public ApplicationData processAcknowledgement(String transmissionName,
 byte[] transmissionContent)
                                       throws Exception

Sample implementation with a two phase acknowledgement.

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 acknowledgement events are only dispatched when Ack2 is received. The acknowledgement message is saved for a failed event. The type name is included as this is a sample generic acknowledgement 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

Parameters:

transmissionName -

transmissionContent -

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

Used to Perform work required after a successful acknowledgement from the Regulatory Agency.

Default implementation:

On the provided regulatory submission, use getCompleteStage() to set the Submission Stage attribute and when the approval date is null, set it to the current time.

If a predecessor regulatory submission version exists, use getHistoryStage() to set the Submission Stage.


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[]

getSubmittedStage

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

Provides the Regulatory Submission Stage for Submitted

Supported API: true

Returns:

SubmissionStage - Configured Submitted Stage

getTransmissionPayloadCategory

public String getTransmissionPayloadCategory()

Returns RegulatoryContentCategory.REGULATORY_SUBMISSION_PAYLOAD.

Supported API: true

Specified by:

getTransmissionPayloadCategory in interface RegulatorySubmissionProcessorInterface

Returns:

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

getCancellationStage

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

Provides the Regulatory Submission Stage for Cancellation

Supported API: true

Returns:

SubmissionStage - Configured Cancellation 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

Parameters:

regulatorySubmission -

Returns:

RegulatorySubmission

Throws:

Exception

getTransmissionDelegate

public RegulatoryTransmissionDelegateInterface getTransmissionDelegate(RegulatorySubmission regulatorySubmission)
                                                                throws Exception

Default implementation: Returns the SimulateTransmissionDelegate if no delegate for the Type is found, Registered with this following entry:

<Service name="com.ptc.qualitymanagement.regmstr.impl.RegulatoryTransmissionDelegateInterface">
<Option requestor="null" serviceClass="com.ptc.qualitymanagement.regmstr.impl.SimulateTransmissionDelegate" selector="default" cardinality="duplicate">
</Service>

Supported API: true

Specified by:

getTransmissionDelegate in interface RegulatorySubmissionProcessorInterface

Parameters:

regulatorySubmission -

Returns:

RegulatoryTransmissionDelegateInterface

Throws:

Exception

submitRegulatorySubmission

public RegulatorySubmission submitRegulatorySubmission(RegulatorySubmission regulatorySubmission)
                                                throws Exception

Default Implementation: Submits the Regulatory Submission using the SimulateTransmissionDelegate. Do not modify the Regulatory Submission in any implementation of this method. Customization can be performed by overriding RegulatorySubmissionProcessorInterface.postSubmissionProcessing(RegulatorySubmission)

Supported API: true

Specified by:

submitRegulatorySubmission in interface RegulatorySubmissionProcessorInterface

Parameters:

regulatorySubmission -

Returns:

RegulatorySubmission

Throws:

Exception

postSubmissionProcessing

public RegulatorySubmission postSubmissionProcessing(RegulatorySubmission regulatorySubmission)
                                              throws Exception

Default implementation: Sets the submittedDate to the current date and sets the submissionStage to Submitted. Uses the ConditionalAutoCheckoutRunner wrapper class, to ensure the regulatory submission object is checked-out and checked-in.

Supported API: true

Specified by:

postSubmissionProcessing in interface RegulatorySubmissionProcessorInterface

Parameters:

regulatorySubmission -

Returns:

RegulatorySubmission

Throws:

Exception

expireRegulatorySubmission

public RegulatorySubmission expireRegulatorySubmission(RegulatorySubmission submission)
                                                throws WTException,
IllegalArgumentException

Default implementation: Marks the provided regulatory submission as expired, changes its SubmissionStage to expired, and fires the RegulatoryMasterServiceEvent.AUTO_EXPIRED event. Additionally, will auto check out and check in a revision-controlled regulatory submission using the ConditionalAutoCheckoutRunner if a working copy is not provided and does not already exist. Will not mark a checked out revision-controlled regulatory submission as expired

Supported API: true

Specified by:

expireRegulatorySubmission in interface RegulatorySubmissionProcessorInterface

Parameters:

submission - The regulatory submission to be expired

Returns:

The version of the regulatory submission which has been marked expired.

Throws:

WTException

IllegalArgumentException

postCancellation

public RegulatorySubmission postCancellation(RegulatorySubmission regulatorySubmission)
                                      throws Exception

Used to perform work required after the cancellation of the submission process of a regulatory submission.

Default implementation:

On the provided regulatory submission, use getCancellationStage() to set the Submission Stage attribute. Additionally, set the terminated date to the current time if it is currently null

Supported API: true

Specified by:

postCancellation in interface RegulatorySubmissionProcessorInterface

Parameters:

regulatorySubmission -

Returns:

RegulatorySubmission

Throws:

Exception

performTrackRegSubActionValidation

public boolean performTrackRegSubActionValidation(RegulatorySubmission regSub2)
                                           throws WTException

Default implementation: Returns False since the action isn't supported for the Simple Regulatory Submission

Supported API: true

Specified by:

performTrackRegSubActionValidation in interface RegulatorySubmissionProcessorInterface

Parameters:

regSub2 -

Returns:

Throws:

WTException