Package com.docusign.esign.model

Class EnvelopeTemplateDefinition

java.lang.Object

com.docusign.esign.model.EnvelopeTemplateDefinition

public class EnvelopeTemplateDefinition
extends Object

A complex element containing the following information: templateId: Unique identifier of the template. If this is not provided, DocuSign will generate a value. name: Name of the template. Maximum length: 100 characters. shared: When set to **true**, the template is shared with the Everyone group in the account. If false, the template is only shared with the Administrator group. password: Password, if the template is locked. description: Description of the template. Maximum Length: 500 characters. pageCount: Number of document pages in the template. folderName: The name of the folder the template is located in. folderId: The ID for the folder. owner: The userName, email, userId, userType, and userStatus for the template owner.

Constructor Summary

Constructors

Constructor	Description
EnvelopeTemplateDefinition()

Method Summary

Modifier and Type	Method	Description
EnvelopeTemplateDefinition	created(String created)
EnvelopeTemplateDefinition	description(String description)
boolean	equals(Object o)
EnvelopeTemplateDefinition	folderId(String folderId)
EnvelopeTemplateDefinition	folderName(String folderName)
EnvelopeTemplateDefinition	folderUri(String folderUri)
String	getCreated()
String	getDescription()
String	getFolderId()	The ID for the folder.
String	getFolderName()	The name of the folder in which the template is located.
String	getFolderUri()	The URI of the folder.
String	getLastModified()
UserInfo	getLastModifiedBy()	Get lastModifiedBy
String	getName()
String	getNewPassword()
UserInfo	getOwner()	Get owner
Integer	getPageCount()	An integer value specifying the number of document pages in the template.
String	getParentFolderUri()
String	getPassword()
String	getShared()	When set to **true**, this custom tab is shared.
String	getTemplateId()	The unique identifier of the template.
String	getUri()
int	hashCode()
EnvelopeTemplateDefinition	lastModified(String lastModified)
EnvelopeTemplateDefinition	lastModifiedBy(UserInfo lastModifiedBy)
EnvelopeTemplateDefinition	name(String name)
EnvelopeTemplateDefinition	newPassword(String newPassword)
EnvelopeTemplateDefinition	owner(UserInfo owner)
EnvelopeTemplateDefinition	pageCount(Integer pageCount)
EnvelopeTemplateDefinition	parentFolderUri(String parentFolderUri)
EnvelopeTemplateDefinition	password(String password)
void	setCreated(String created)
void	setDescription(String description)
void	setFolderId(String folderId)
void	setFolderName(String folderName)
void	setFolderUri(String folderUri)
void	setLastModified(String lastModified)
void	setLastModifiedBy(UserInfo lastModifiedBy)
void	setName(String name)
void	setNewPassword(String newPassword)
void	setOwner(UserInfo owner)
void	setPageCount(Integer pageCount)
void	setParentFolderUri(String parentFolderUri)
void	setPassword(String password)
void	setShared(String shared)
void	setTemplateId(String templateId)
void	setUri(String uri)
EnvelopeTemplateDefinition	shared(String shared)
EnvelopeTemplateDefinition	templateId(String templateId)
String	toString()
EnvelopeTemplateDefinition	uri(String uri)

Methods inherited from class java.lang.Object

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

Constructor Detail

EnvelopeTemplateDefinition

public EnvelopeTemplateDefinition()

Method Detail

created

public EnvelopeTemplateDefinition created(String created)

getCreated

public String getCreated()

Returns:

created

setCreated

public void setCreated(String created)

description

public EnvelopeTemplateDefinition description(String description)

getDescription

public String getDescription()

Returns:

description

setDescription

public void setDescription(String description)

folderId

public EnvelopeTemplateDefinition folderId(String folderId)

getFolderId

public String getFolderId()

The ID for the folder.

Returns:

folderId

setFolderId

public void setFolderId(String folderId)

folderName

public EnvelopeTemplateDefinition folderName(String folderName)

getFolderName

public String getFolderName()

The name of the folder in which the template is located.

Returns:

folderName

setFolderName

public void setFolderName(String folderName)

folderUri

public EnvelopeTemplateDefinition folderUri(String folderUri)

getFolderUri

public String getFolderUri()

The URI of the folder.

Returns:

folderUri

setFolderUri

public void setFolderUri(String folderUri)

lastModified

public EnvelopeTemplateDefinition lastModified(String lastModified)

getLastModified

public String getLastModified()

Returns:

lastModified

setLastModified

public void setLastModified(String lastModified)

lastModifiedBy

public EnvelopeTemplateDefinition lastModifiedBy(UserInfo lastModifiedBy)

getLastModifiedBy

public UserInfo getLastModifiedBy()

Get lastModifiedBy

Returns:

lastModifiedBy

setLastModifiedBy

public void setLastModifiedBy(UserInfo lastModifiedBy)

name

public EnvelopeTemplateDefinition name(String name)

getName

public String getName()

Returns:

name

setName

public void setName(String name)

newPassword

public EnvelopeTemplateDefinition newPassword(String newPassword)

getNewPassword

public String getNewPassword()

Returns:

newPassword

setNewPassword

public void setNewPassword(String newPassword)

owner

public EnvelopeTemplateDefinition owner(UserInfo owner)

getOwner

public UserInfo getOwner()

Get owner

Returns:

owner

setOwner

public void setOwner(UserInfo owner)

pageCount

public EnvelopeTemplateDefinition pageCount(Integer pageCount)

getPageCount

public Integer getPageCount()

An integer value specifying the number of document pages in the template. Omit this property if not submitting a page count.

Returns:

pageCount

setPageCount

public void setPageCount(Integer pageCount)

parentFolderUri

public EnvelopeTemplateDefinition parentFolderUri(String parentFolderUri)

getParentFolderUri

public String getParentFolderUri()

Returns:

parentFolderUri

setParentFolderUri

public void setParentFolderUri(String parentFolderUri)

password

public EnvelopeTemplateDefinition password(String password)

getPassword

public String getPassword()

Returns:

password

setPassword

public void setPassword(String password)

shared

public EnvelopeTemplateDefinition shared(String shared)

getShared

public String getShared()

When set to **true**, this custom tab is shared.

Returns:

shared

setShared

public void setShared(String shared)

templateId

public EnvelopeTemplateDefinition templateId(String templateId)

getTemplateId

public String getTemplateId()

The unique identifier of the template. If this is not provided, DocuSign will generate a value.

Returns:

templateId

setTemplateId

public void setTemplateId(String templateId)

uri

public EnvelopeTemplateDefinition uri(String uri)

getUri

public String getUri()

Returns:

uri

setUri

public void setUri(String uri)

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