public class Document extends Object implements Serializable
The document class contains data describing pages, signatures and their associated data and layout.>
Allowed file types for uploaded documents are Adobe PDF (.pdf), a Microsoft Word (.doc or.docx), an IBM Symphony (.odt),
or an Open Document (.odt) file.
Any document that is not having the .pdf extension will be automatically converted to Adobe pdf based on its extension.
This conversion is achieved during the package creation.
Constructor and Description |
---|
Document() |
Modifier and Type | Method and Description |
---|---|
void |
addInjectedFields(List<Field> fields) |
void |
addQRCodes(List<Field> fields) |
void |
addSignatures(List<Signature> signatures) |
byte[] |
getContent()
Accessor method used to retrieve the content of a document
|
String |
getDescription() |
External |
getExternal()
Accessor method used to get the information from the external provider
|
String |
getFileName()
Accessor method used to retrieve the file name
|
DocumentId |
getId()
Accessor method used to get the ID of the document
|
int |
getIndex()
Accessor method used to retrieve the document signing order
|
List<Field> |
getInjectedFields() |
String |
getName()
Accessor method used to retrieve the name of a document
|
List<Field> |
getQrCodes() |
Collection<Signature> |
getSignatures()
Accessor method used to retrieve the document signatures
|
boolean |
isExtract() |
void |
setContent(byte[] content)
Accessor method used to set the content of a document
|
void |
setDescription(String description) |
void |
setExternal(External external)
Accessor method used to set the document external provider
|
void |
setExtraction(boolean extract) |
void |
setFileName(String fileName)
Accessor method used to set the file name
|
void |
setId(DocumentId id)
Accessor method used to set the document ID
|
void |
setIndex(int position)
Accessor method used to specify the order that document must be signed in.
|
void |
setName(String name)
Accessor method to set the name of a document
|
public String getFileName()
Accessor method used to retrieve the file name
public void setFileName(String fileName)
Accessor method used to set the file name
fileName
- the file namepublic byte[] getContent()
Accessor method used to retrieve the content of a document
public void setContent(byte[] content)
content
- the document contentpublic void setName(String name)
Accessor method to set the name of a document
name
- the document namepublic String getName()
Accessor method used to retrieve the name of a document
public Collection<Signature> getSignatures()
Accessor method used to retrieve the document signatures
public void setIndex(int position)
Accessor method used to specify the order that document must be signed in.
So, a document with an index set to 1 will be signed before a document with an index set to 2, and so on.
position
- the document signing orderpublic int getIndex()
Accessor method used to retrieve the document signing order
public void setExtraction(boolean extract)
extract
- public boolean isExtract()
public void setId(DocumentId id)
Accessor method used to set the document ID
id
- the ID of the documentpublic DocumentId getId()
Accessor method used to get the ID of the document
public External getExternal()
Accessor method used to get the information from the external provider
public void setExternal(External external)
Accessor method used to set the document external provider
external
- the external provider of the document null if nonepublic void setDescription(String description)
public String getDescription()
Copyright 2014, Silanis Technology, Inc. All rights reserved.