Package com.docusign.esign.model

Class CompositeTemplate

  • All Implemented Interfaces:
    Serializable
    public class CompositeTemplate
extends Object
implements Serializable
    This object contains information about a [composite template][composite], which you can use to to apply multiple templates to a single envelope, combine templates with PDF forms, and combine templates with documents from cloud sources. [composite]: /docs/esign-rest-api/esign101/concepts/templates/composite/.
    See Also:
    Serialized Form

    • Constructor Detail

      • CompositeTemplate

        public CompositeTemplate()

    • Method Detail

      • compositeTemplateId

        public CompositeTemplate compositeTemplateId​(String compositeTemplateId)
        compositeTemplateId.
        Returns:
        CompositeTemplate

      • 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)
        setCompositeTemplateId.

      • getDocument

        public Document getDocument()
        An optional document object that will act as the primary document in the composite template object. If the document node is present, it will take precedence over any server template or inline template documents. It always comes first. Only use this when you want to supply the document dynamically..
        Returns:
        document

      • setDocument

        public void setDocument​(Document document)
        setDocument.

      • addInlineTemplatesItem

        public CompositeTemplate addInlineTemplatesItem​(InlineTemplate inlineTemplatesItem)
        addInlineTemplatesItem.
        Returns:
        CompositeTemplate

      • 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)
        setInlineTemplates.

      • pdfMetaDataTemplateSequence

        public CompositeTemplate pdfMetaDataTemplateSequence​(String pdfMetaDataTemplateSequence)
        pdfMetaDataTemplateSequence.
        Returns:
        CompositeTemplate

      • getPdfMetaDataTemplateSequence

        public String getPdfMetaDataTemplateSequence()
        .
        Returns:
        pdfMetaDataTemplateSequence

      • setPdfMetaDataTemplateSequence

        public void setPdfMetaDataTemplateSequence​(String pdfMetaDataTemplateSequence)
        setPdfMetaDataTemplateSequence.

      • addServerTemplatesItem

        public CompositeTemplate addServerTemplatesItem​(ServerTemplate serverTemplatesItem)
        addServerTemplatesItem.
        Returns:
        CompositeTemplate

      • 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)
        setServerTemplates.

      • equals

        public boolean equals​(Object o)
        Compares objects.
        Overrides:
        equals in class Object
        Returns:
        true or false depending on comparison result.

      • hashCode

        public int hashCode()
        Returns the HashCode.
        Overrides:
        hashCode in class Object

      • toString

        public String toString()
        Converts the given object to string.
        Overrides:
        toString in class Object