Package com.docusign.esign.model
Class CompositeTemplate
- java.lang.Object
-
- com.docusign.esign.model.CompositeTemplate
-
public class CompositeTemplate extends java.lang.ObjectCompositeTemplate.
-
-
Constructor Summary
Constructors Constructor Description CompositeTemplate()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description CompositeTemplateaddInlineTemplatesItem(InlineTemplate inlineTemplatesItem)addInlineTemplatesItem.CompositeTemplateaddServerTemplatesItem(ServerTemplate serverTemplatesItem)addServerTemplatesItem.CompositeTemplatecompositeTemplateId(java.lang.String compositeTemplateId)compositeTemplateId.CompositeTemplatedocument(Document document)document.booleanequals(java.lang.Object o)Compares objects.java.lang.StringgetCompositeTemplateId()The identify of this composite template.DocumentgetDocument()Get document.java.util.List<InlineTemplate>getInlineTemplates()Zero or more inline templates and their position in the overlay.java.lang.StringgetPdfMetaDataTemplateSequence().java.util.List<ServerTemplate>getServerTemplates()0 or more server-side templates and their position in the overlay.inthashCode()Returns the HashCode.CompositeTemplateinlineTemplates(java.util.List<InlineTemplate> inlineTemplates)inlineTemplates.CompositeTemplatepdfMetaDataTemplateSequence(java.lang.String pdfMetaDataTemplateSequence)pdfMetaDataTemplateSequence.CompositeTemplateserverTemplates(java.util.List<ServerTemplate> serverTemplates)serverTemplates.voidsetCompositeTemplateId(java.lang.String compositeTemplateId)setCompositeTemplateId.voidsetDocument(Document document)setDocument.voidsetInlineTemplates(java.util.List<InlineTemplate> inlineTemplates)setInlineTemplates.voidsetPdfMetaDataTemplateSequence(java.lang.String pdfMetaDataTemplateSequence)setPdfMetaDataTemplateSequence.voidsetServerTemplates(java.util.List<ServerTemplate> serverTemplates)setServerTemplates.java.lang.StringtoString()Converts the given object to string.
-
-
-
Method Detail
-
compositeTemplateId
public CompositeTemplate compositeTemplateId(java.lang.String compositeTemplateId)
compositeTemplateId.- Returns:
- CompositeTemplate
-
getCompositeTemplateId
public java.lang.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(java.lang.String compositeTemplateId)
setCompositeTemplateId.
-
document
public CompositeTemplate document(Document document)
document.- Returns:
- CompositeTemplate
-
getDocument
public Document getDocument()
Get document.- Returns:
- document
-
setDocument
public void setDocument(Document document)
setDocument.
-
inlineTemplates
public CompositeTemplate inlineTemplates(java.util.List<InlineTemplate> inlineTemplates)
inlineTemplates.- Returns:
- CompositeTemplate
-
addInlineTemplatesItem
public CompositeTemplate addInlineTemplatesItem(InlineTemplate inlineTemplatesItem)
addInlineTemplatesItem.- Returns:
- CompositeTemplate
-
getInlineTemplates
public java.util.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(java.util.List<InlineTemplate> inlineTemplates)
setInlineTemplates.
-
pdfMetaDataTemplateSequence
public CompositeTemplate pdfMetaDataTemplateSequence(java.lang.String pdfMetaDataTemplateSequence)
pdfMetaDataTemplateSequence.- Returns:
- CompositeTemplate
-
getPdfMetaDataTemplateSequence
public java.lang.String getPdfMetaDataTemplateSequence()
.- Returns:
- pdfMetaDataTemplateSequence
-
setPdfMetaDataTemplateSequence
public void setPdfMetaDataTemplateSequence(java.lang.String pdfMetaDataTemplateSequence)
setPdfMetaDataTemplateSequence.
-
serverTemplates
public CompositeTemplate serverTemplates(java.util.List<ServerTemplate> serverTemplates)
serverTemplates.- Returns:
- CompositeTemplate
-
addServerTemplatesItem
public CompositeTemplate addServerTemplatesItem(ServerTemplate serverTemplatesItem)
addServerTemplatesItem.- Returns:
- CompositeTemplate
-
getServerTemplates
public java.util.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(java.util.List<ServerTemplate> serverTemplates)
setServerTemplates.
-
equals
public boolean equals(java.lang.Object o)
Compares objects.- Overrides:
equalsin classjava.lang.Object- Returns:
- true or false depending on comparison result.
-
hashCode
public int hashCode()
Returns the HashCode.- Overrides:
hashCodein classjava.lang.Object
-
toString
public java.lang.String toString()
Converts the given object to string.- Overrides:
toStringin classjava.lang.Object
-
-