Package com.adobe.fd.fp.api.service

Interface SubmitService

@ProviderType
public interface SubmitService

Interface exposing the Submission Model SPI's in Forms Portal

Method Summary

Modifier and Type	Method	Description
boolean	deleteSubmission(java.lang.String submissionId)
java.util.List<SubmitModel>	getAllSubmission(Query query)	Method returns the list of all submission models present
SubmitModel	getSubmission(java.lang.String submissionId)	Method returns the submit model against the provided submissionId
SubmitModel	getSubmission(java.lang.String submissionId, Query query)	Method returns the submit model against the provided submissionId and query
java.lang.String	saveSubmission(SubmitModel submissionModel)	Saves the SubmitModel into the storage

Method Detail

saveSubmission

java.lang.String saveSubmission(SubmitModel submissionModel)
                         throws FormsPortalException

Saves the SubmitModel into the storage

Parameters:

submissionModel - SubmitModel to be persisted

Returns:

uniqueID generated corresponding to the model. Can be re-used while fetching the same

Throws:

FormsPortalException

getSubmission

SubmitModel getSubmission(java.lang.String submissionId)
                   throws FormsPortalException

Method returns the submit model against the provided submissionId

Parameters:

submissionId - submissionId against which submit model needs to be fetched

Returns:

SubmitModel as per the provided submissionId

Throws:

FormsPortalException

getSubmission

SubmitModel getSubmission(java.lang.String submissionId,
                          Query query)
                   throws FormsPortalException

Method returns the submit model against the provided submissionId and query

Parameters:

submissionId - submissionId against which submit model needs to be fetched

query - Query to define cut points, filtering etc

Returns:

SubmitModel as per the provided submissionId and query filter

Throws:

FormsPortalException

getAllSubmission

java.util.List<SubmitModel> getAllSubmission(Query query)
                                      throws FormsPortalException

Method returns the list of all submission models present

Parameters:

query - Query to define cut points, filtering etc

Returns:

list of SubmitModel

Throws:

FormsPortalException

deleteSubmission

boolean deleteSubmission(java.lang.String submissionId)
                  throws FormsPortalException

Parameters:

submissionId - submissionId of the submit model that needs to be deleted

Returns:

True if update was successful, else false

Throws:

FormsPortalException