com.docusign.esign.model

Class CompositeTemplate

java.lang.Object

com.docusign.esign.model.CompositeTemplate

public class CompositeTemplate
extends Object

CompositeTemplate

Constructor Summary

Constructors

Constructor and Description
CompositeTemplate()

Method Summary

Modifier and Type	Method and Description
CompositeTemplate	addInlineTemplatesItem(InlineTemplate inlineTemplatesItem)
CompositeTemplate	addServerTemplatesItem(ServerTemplate serverTemplatesItem)
CompositeTemplate	compositeTemplateId(String compositeTemplateId)
CompositeTemplate	document(Document document)
boolean	equals(Object o)
String	getCompositeTemplateId() The identify of this composite template.
Document	getDocument() Get document
List<InlineTemplate>	getInlineTemplates() Zero or more inline templates and their position in the overlay.
String	getPdfMetaDataTemplateSequence()
List<ServerTemplate>	getServerTemplates() 0 or more server-side templates and their position in the overlay.
int	hashCode()
CompositeTemplate	inlineTemplates(List<InlineTemplate> inlineTemplates)
CompositeTemplate	pdfMetaDataTemplateSequence(String pdfMetaDataTemplateSequence)
CompositeTemplate	serverTemplates(List<ServerTemplate> serverTemplates)
void	setCompositeTemplateId(String compositeTemplateId)
void	setDocument(Document document)
void	setInlineTemplates(List<InlineTemplate> inlineTemplates)
void	setPdfMetaDataTemplateSequence(String pdfMetaDataTemplateSequence)
void	setServerTemplates(List<ServerTemplate> serverTemplates)
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CompositeTemplate

public CompositeTemplate()

Method Detail

compositeTemplateId

public CompositeTemplate compositeTemplateId(String compositeTemplateId)

getCompositeTemplateId

public String getCompositeTemplateId()

The identify of this composite template. It is used as a reference when adding document object information. If used, the document's `content-disposition` must include the composite template ID to which the document should be added. If a composite template ID is not specified in the content-disposition, the document is applied based on the value of the `documentId` property only. If no document object is specified, the composite template inherits the first document.

Returns:

compositeTemplateId

setCompositeTemplateId

public void setCompositeTemplateId(String compositeTemplateId)

document

public CompositeTemplate document(Document document)

getDocument

public Document getDocument()

Get document

Returns:

document

setDocument

public void setDocument(Document document)

inlineTemplates

public CompositeTemplate inlineTemplates(List<InlineTemplate> inlineTemplates)

addInlineTemplatesItem

public CompositeTemplate addInlineTemplatesItem(InlineTemplate inlineTemplatesItem)

getInlineTemplates

public List<InlineTemplate> getInlineTemplates()

Zero or more inline templates and their position in the overlay. If supplied, they are overlaid into the envelope in the order of their Sequence value.

Returns:

inlineTemplates

setInlineTemplates

public void setInlineTemplates(List<InlineTemplate> inlineTemplates)

pdfMetaDataTemplateSequence

public CompositeTemplate pdfMetaDataTemplateSequence(String pdfMetaDataTemplateSequence)

getPdfMetaDataTemplateSequence

public String getPdfMetaDataTemplateSequence()

Returns:

pdfMetaDataTemplateSequence

setPdfMetaDataTemplateSequence

public void setPdfMetaDataTemplateSequence(String pdfMetaDataTemplateSequence)

serverTemplates

public CompositeTemplate serverTemplates(List<ServerTemplate> serverTemplates)

addServerTemplatesItem

public CompositeTemplate addServerTemplatesItem(ServerTemplate serverTemplatesItem)

getServerTemplates

public List<ServerTemplate> getServerTemplates()

0 or more server-side templates and their position in the overlay. If supplied, they are overlaid into the envelope in the order of their Sequence value

Returns:

serverTemplates

setServerTemplates

public void setServerTemplates(List<ServerTemplate> serverTemplates)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object