com.silanis.esl.sdk.service

Class ApprovalService

java.lang.Object

com.silanis.esl.sdk.service.ApprovalService

public class ApprovalService
extends Object

Created by chi-wing on 6/19/14.

Constructor Summary

Constructors

Constructor and Description
ApprovalService(ApprovalApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
String	addField(PackageId packageId, String documentId, SignatureId signatureId, Field field) Add a field to a signature
String	addSignature(DocumentPackage sdkPackage, String documentId, Signature signature) Add a signature to a document
void	deleteField(PackageId packageId, String documentId, SignatureId signatureId, FieldId fieldId) Delete a field from a signature
void	deleteSignature(PackageId packageId, String documentId, SignatureId signatureId) Delete a signature from a document
List<Signature>	getAllSignableSignatures(DocumentPackage sdkPackage, String documentId, String signerId) Get all signable signatures
Field	getField(PackageId packageId, String documentId, SignatureId signatureId, FieldId fieldId) Get a field from a signature
Signature	getSignature(DocumentPackage sdkPackage, String documentId, SignatureId signatureId) Get a signature from a document
void	modifySignature(DocumentPackage sdkPackage, String documentId, Signature signature) Update a signature from a document
void	updateConditionalField(PackageId packageId, String documentId, SignatureId signatureId, ConditionalField conditionalField) Update a conditional field from a signature
void	updateField(PackageId packageId, String documentId, SignatureId signatureId, Field field) Update a field from a signature
void	updateSignatures(DocumentPackage sdkPackage, String documentId, List<Signature> signatureList) Update all the signatures for a document

Methods inherited from class java.lang.Object

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

Constructor Detail

ApprovalService

public ApprovalService(ApprovalApiClient apiClient)

Method Detail

deleteSignature

public void deleteSignature(PackageId packageId,
                            String documentId,
                            SignatureId signatureId)
                     throws EslException

Delete a signature from a document

Parameters:

packageId - The package Id

documentId - The document Id

signatureId - The approval Id

Throws:

EslException

addSignature

public String addSignature(DocumentPackage sdkPackage,
                           String documentId,
                           Signature signature)
                    throws EslException

Add a signature to a document

Parameters:

sdkPackage - The sdk package containing the signature

documentId - The document Id

signature - The signature to be added

Returns:

The signature Id

Throws:

EslException

modifySignature

public void modifySignature(DocumentPackage sdkPackage,
                            String documentId,
                            Signature signature)
                     throws EslException

Update a signature from a document

Parameters:

sdkPackage - The sdk package containing the signature

documentId - The document Id

signature - The signature with updated information

Throws:

EslException

updateSignatures

public void updateSignatures(DocumentPackage sdkPackage,
                             String documentId,
                             List<Signature> signatureList)

Update all the signatures for a document

Parameters:

sdkPackage - The sdk package containing the signatures

documentId - The document Id of document containing the signatures

signatureList - The list of signatures to update for the document

getSignature

public Signature getSignature(DocumentPackage sdkPackage,
                              String documentId,
                              SignatureId signatureId)
                       throws EslException

Get a signature from a document

Parameters:

sdkPackage - The sdk package containing the signature

documentId - The document Id

signatureId - The approval Id

Returns:

The requested Signature

Throws:

EslException

getAllSignableSignatures

public List<Signature> getAllSignableSignatures(DocumentPackage sdkPackage,
                                                String documentId,
                                                String signerId)
                                         throws EslException

Get all signable signatures

Parameters:

sdkPackage - The sdk package containing the signature

documentId - The document Id

signerId - The signer Id

Returns:

All signable signatures

Throws:

EslException

addField

public String addField(PackageId packageId,
                       String documentId,
                       SignatureId signatureId,
                       Field field)

Add a field to a signature

Parameters:

packageId - The package Id

documentId - The document Id

signatureId - The approval Id

field - The SDK Field to be added

Returns:

The field Id

updateField

public void updateField(PackageId packageId,
                        String documentId,
                        SignatureId signatureId,
                        Field field)

Update a field from a signature

Parameters:

packageId - The package Id

documentId - The document Id

signatureId - The approval Id

field - The SDK Field to be updated

updateConditionalField

public void updateConditionalField(PackageId packageId,
                                   String documentId,
                                   SignatureId signatureId,
                                   ConditionalField conditionalField)

Update a conditional field from a signature

Parameters:

packageId - The package Id

documentId - The document Id

signatureId - The approval Id

conditionalField - The SDK Conditional Field to be updated

deleteField

public void deleteField(PackageId packageId,
                        String documentId,
                        SignatureId signatureId,
                        FieldId fieldId)

Delete a field from a signature

Parameters:

packageId - The package Id

documentId - The document Id

signatureId - The approval Id

fieldId - The field Id

getField

public Field getField(PackageId packageId,
                      String documentId,
                      SignatureId signatureId,
                      FieldId fieldId)

Get a field from a signature

Parameters:

packageId - The package Id

documentId - The document Id

signatureId - The approval Id

fieldId - The field Id

Returns:

The field corresponding to the specified Ids