com.silanis.esl.sdk

Class DocumentPackage

java.lang.Object

com.silanis.esl.sdk.DocumentPackage

All Implemented Interfaces:

Serializable

public class DocumentPackage
extends Object
implements Serializable

DocumentPackage class describes all assets required for a complete signing transaction. It contains information about signers, documents, signatures, fields and settings for displaying the signing ceremony

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
DocumentPackage(String name, List<Signer> signers, List<Signer> placeholders, List<Document> documents, boolean autocomplete)

Method Summary

Modifier and Type	Method and Description
void	addSigner(Signer signer) Adds a signer
DocumentPackageAttributes	getAttributes()
boolean	getAutocomplete() Returns the autocomplete status
List<FieldCondition>	getConditions()
Date	getCreatedDate()
String	getDescription()
Document	getDocument(String name)
List<Document>	getDocuments() Retrieve all the package documents
Date	getExpiryDate()
PackageId	getId()
Locale	getLanguage()
List<Message>	getMessages() Get the package's messages (ex: opt out or decline messages).
String	getName()
Boolean	getNotarized()
String	getPackageMessage()
Signer	getPlaceholder(String id)
List<Signer>	getPlaceholders()
SenderInfo	getSenderInfo()
DocumentPackageSettings	getSettings()
Signer	getSigner(String email) Retrieves a signer by its email address
Signer	getSignerByEmailAndId(String email, String signerId) Retrieves a signer by its email address and id
Signer	getSignerById(String signerId) Retrieves a signer by its id
List<Signer>	getSigners()
List<Signer>	getSignersByEmail(String email) Retrieves signers by email address
PackageStatus	getStatus()
String	getTimezoneId()
Boolean	getTrashed()
Date	getUpdatedDate()
Visibility	getVisibility()
void	removePlaceholder(Signer signer)
void	removeSigner(Signer signer) Removes a signer
void	setAttributes(DocumentPackageAttributes attributes)
void	setConditions(List<FieldCondition> conditions)
void	setCreatedDate(Date createdDate)
void	setDescription(String description) Sets the description for the document package
void	setExpiryDate(Date expiryDate) Sets the expiration date for the document package.
void	setId(PackageId id)
void	setLanguage(Locale language)
void	setMessages(List<Message> messages)
void	setName(String name)
void	setNotarized(Boolean notarized)
void	setPackageMessage(String packageMessage) Sets the package message
void	setSenderInfo(SenderInfo senderInfo)
void	setSettings(DocumentPackageSettings settings)
void	setStatus(PackageStatus status)
void	setTimezoneId(String timezoneId)
void	setTrashed(Boolean trashed)
void	setUpdatedDate(Date updatedDate)
void	setVisibility(Visibility visibility)

Methods inherited from class java.lang.Object

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

Constructor Detail

DocumentPackage

public DocumentPackage(String name,
                       List<Signer> signers,
                       List<Signer> placeholders,
                       List<Document> documents,
                       boolean autocomplete)

Parameters:

name - the name of the package

signers - the Map of signers

documents - the Map of documents

autocomplete - the autocomplete status. If it is set to true, then the document package will be marked as completed automatically by the system

Method Detail

setName

public void setName(String name)

getName

public String getName()

Returns:

the document package name

getSigner

public Signer getSigner(String email)

Retrieves a signer by its email address

Parameters:

email -

Returns:

the first signer who's email address matches the one provided as parameter

getSignerById

public Signer getSignerById(String signerId)

Retrieves a signer by its id

Parameters:

signerId -

Returns:

the signer whose id matches the one provided as parameter

getSignerByEmailAndId

public Signer getSignerByEmailAndId(String email,
                                    String signerId)

Retrieves a signer by its email address and id

Parameters:

email -

signerId -

Returns:

the signer whose email address and id match provided as parameter

getSignersByEmail

public List<Signer> getSignersByEmail(String email)

Retrieves signers by email address

Parameters:

email -

Returns:

the signers whose email address matches the one provided as parameter

addSigner

public void addSigner(Signer signer)

Adds a signer

Parameters:

signer - the signer to add

removeSigner

public void removeSigner(Signer signer)

Removes a signer

Parameters:

signer - the signer to remove

getSigners

public List<Signer> getSigners()

removePlaceholder

public void removePlaceholder(Signer signer)

getPlaceholders

public List<Signer> getPlaceholders()

getPlaceholder

public Signer getPlaceholder(String id)

getDocument

public Document getDocument(String name)

Parameters:

name - the document name

Returns:

the document identified by the name provided as parameter

getAutocomplete

public boolean getAutocomplete()

Returns the autocomplete status

Returns:

true if the autocomplete status is set to true false otherwise.

getDocuments

public List<Document> getDocuments()

Retrieve all the package documents

Returns:

Collection of documents

setDescription

public void setDescription(String description)

Sets the description for the document package

Parameters:

description - Description of the package

getDescription

public String getDescription()

setExpiryDate

public void setExpiryDate(Date expiryDate)

Sets the expiration date for the document package. TODO: What is happening after the date surpasses the expiration date and the transaction is not yet completed?

Parameters:

expiryDate -

getExpiryDate

public Date getExpiryDate()

setUpdatedDate

public void setUpdatedDate(Date updatedDate)

getUpdatedDate

public Date getUpdatedDate()

getCreatedDate

public Date getCreatedDate()

setCreatedDate

public void setCreatedDate(Date createdDate)

setPackageMessage

public void setPackageMessage(String packageMessage)

Sets the package message

Parameters:

packageMessage - This is a message that will get added to the email invitation sent to all signers of a package

getPackageMessage

public String getPackageMessage()

setId

public void setId(PackageId id)

getId

public PackageId getId()

setStatus

public void setStatus(PackageStatus status)

getStatus

public PackageStatus getStatus()

getSettings

public DocumentPackageSettings getSettings()

setSettings

public void setSettings(DocumentPackageSettings settings)

setLanguage

public void setLanguage(Locale language)

getLanguage

public Locale getLanguage()

setSenderInfo

public void setSenderInfo(SenderInfo senderInfo)

getSenderInfo

public SenderInfo getSenderInfo()

getAttributes

public DocumentPackageAttributes getAttributes()

setAttributes

public void setAttributes(DocumentPackageAttributes attributes)

getMessages

public List<Message> getMessages()

Get the package's messages (ex: opt out or decline messages).

Returns:

the list of package messages.

setMessages

public void setMessages(List<Message> messages)

getNotarized

public Boolean getNotarized()

setNotarized

public void setNotarized(Boolean notarized)

getTrashed

public Boolean getTrashed()

setTrashed

public void setTrashed(Boolean trashed)

getVisibility

public Visibility getVisibility()

setVisibility

public void setVisibility(Visibility visibility)

getTimezoneId

public String getTimezoneId()

setTimezoneId

public void setTimezoneId(String timezoneId)

getConditions

public List<FieldCondition> getConditions()

setConditions

public void setConditions(List<FieldCondition> conditions)