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

Interface PendingSignService

@ProviderType
public interface PendingSignService

Interface exposing the Pending Sign SPI's in Forms Portal

Method Summary

Modifier and Type	Method	Description
boolean	cancelPendingSign(java.lang.String pendingSignId)
boolean	deletePendingSign(java.lang.String pendingSignId)
java.util.List<PendingSignModel>	getAllPendingSign(Query query)	Method returns the list of all pending sign models present
PendingSignModel	getPendingSign(java.lang.String pendingSignId)	Method returns the pending sign model against the provided pendingSignId
PendingSignModel	getPendingSign(java.lang.String pendingSignId, Query query)	Method returns the pending sign model against the provided pendingSignId and query
FileAttachmentWrapper	getSignedDocument(java.lang.String pendingSignId)	Returns the signed document from adobe sign server
java.lang.String	savePendingSign(PendingSignModel pendingSignModel)	Saves the PendingSignModel into the storage
boolean	updatePendingSign(java.lang.String pendingSignId, PendingSignModel pendingSignModel)	Updates the pending sign against the provided pendingSignId.

Method Detail

getPendingSign

PendingSignModel getPendingSign(java.lang.String pendingSignId)
                         throws FormsPortalException

Method returns the pending sign model against the provided pendingSignId

Parameters:

pendingSignId - pendingSignId against with pending sign model needs to be fetched

Returns:

PendingSignModel as per the provided pendingSignId

Throws:

FormsPortalException

getPendingSign

PendingSignModel getPendingSign(java.lang.String pendingSignId,
                                Query query)
                         throws FormsPortalException

Method returns the pending sign model against the provided pendingSignId and query

Parameters:

pendingSignId - pendingSignId against with pending sign model needs to be fetched

query - Query to define cut points, filtering etc

Returns:

PendingSignModel as per the provided pending sign model and query filter

Throws:

FormsPortalException

getAllPendingSign

java.util.List<PendingSignModel> getAllPendingSign(Query query)
                                            throws FormsPortalException

Method returns the list of all pending sign models present

Parameters:

query - Query to define cut points, filtering etc

Returns:

list of PendingSignModel

Throws:

FormsPortalException

savePendingSign

java.lang.String savePendingSign(PendingSignModel pendingSignModel)
                          throws FormsPortalException

Saves the PendingSignModel into the storage

Parameters:

pendingSignModel - PendingSignModel to be persisted

Returns:

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

Throws:

FormsPortalException

updatePendingSign

boolean updatePendingSign(java.lang.String pendingSignId,
                          PendingSignModel pendingSignModel)
                   throws FormsPortalException

Updates the pending sign against the provided pendingSignId. Whole pending sign model will be overridden by the one passed during method call

Parameters:

pendingSignId - pendingSignId whose model needs to be updated

pendingSignModel - PendingSignModel the new pending sign model

Returns:

True if update was successful, else false

Throws:

FormsPortalException

deletePendingSign

boolean deletePendingSign(java.lang.String pendingSignId)
                   throws FormsPortalException

Parameters:

pendingSignId - pendingSignId of the pending sign model that needs to be deleted

Returns:

True if update was successful, else false

Throws:

FormsPortalException

cancelPendingSign

boolean cancelPendingSign(java.lang.String pendingSignId)
                   throws FormsPortalException

Parameters:

pendingSignId - pendingSignId of the pending sign model that needs to be cancelled

Returns:

True if update was successful, else false

Throws:

FormsPortalException

getSignedDocument

FileAttachmentWrapper getSignedDocument(java.lang.String pendingSignId)
                                 throws FormsPortalException

Returns the signed document from adobe sign server

Parameters:

pendingSignId - pendingSignId of the pending sign model whose document needs to be fetched

Returns:

attachment FileAttachmentWrapper the signed document

Throws:

FormsPortalException