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
All Methods Instance Methods Concrete Methods Modifier and Type Method Description EnvelopeTemplateDefinitioncreated(String created)created.EnvelopeTemplateDefinitiondescription(String description)description.booleanequals(Object o)Compares objects.EnvelopeTemplateDefinitionfolderId(String folderId)folderId.EnvelopeTemplateDefinitionfolderName(String folderName)folderName.EnvelopeTemplateDefinitionfolderUri(String folderUri)folderUri.StringgetCreated().StringgetDescription().StringgetFolderId()The ID for the folder..StringgetFolderName()The name of the folder in which the template is located..StringgetFolderUri()The URI of the folder..StringgetLastModified().UserInfogetLastModifiedBy()Get lastModifiedBy.StringgetName().StringgetNewPassword().UserInfogetOwner()Get owner.IntegergetPageCount()An integer value specifying the number of document pages in the template.StringgetParentFolderUri().StringgetPassword().StringgetShared()When set to **true**, this custom tab is shared..StringgetTemplateId()The unique identifier of the template.StringgetUri().inthashCode()Returns the HashCode.EnvelopeTemplateDefinitionlastModified(String lastModified)lastModified.EnvelopeTemplateDefinitionlastModifiedBy(UserInfo lastModifiedBy)lastModifiedBy.EnvelopeTemplateDefinitionname(String name)name.EnvelopeTemplateDefinitionnewPassword(String newPassword)newPassword.EnvelopeTemplateDefinitionowner(UserInfo owner)owner.EnvelopeTemplateDefinitionpageCount(Integer pageCount)pageCount.EnvelopeTemplateDefinitionparentFolderUri(String parentFolderUri)parentFolderUri.EnvelopeTemplateDefinitionpassword(String password)password.voidsetCreated(String created)setCreated.voidsetDescription(String description)setDescription.voidsetFolderId(String folderId)setFolderId.voidsetFolderName(String folderName)setFolderName.voidsetFolderUri(String folderUri)setFolderUri.voidsetLastModified(String lastModified)setLastModified.voidsetLastModifiedBy(UserInfo lastModifiedBy)setLastModifiedBy.voidsetName(String name)setName.voidsetNewPassword(String newPassword)setNewPassword.voidsetOwner(UserInfo owner)setOwner.voidsetPageCount(Integer pageCount)setPageCount.voidsetParentFolderUri(String parentFolderUri)setParentFolderUri.voidsetPassword(String password)setPassword.voidsetShared(String shared)setShared.voidsetTemplateId(String templateId)setTemplateId.voidsetUri(String uri)setUri.EnvelopeTemplateDefinitionshared(String shared)shared.EnvelopeTemplateDefinitiontemplateId(String templateId)templateId.StringtoString()Converts the given object to string.EnvelopeTemplateDefinitionuri(String uri)uri.
-
-
-
Method Detail
-
created
public EnvelopeTemplateDefinition created(String created)
created.- Returns:
- EnvelopeTemplateDefinition
-
getCreated
public String getCreated()
.- Returns:
- created
-
setCreated
public void setCreated(String created)
setCreated.
-
description
public EnvelopeTemplateDefinition description(String description)
description.- Returns:
- EnvelopeTemplateDefinition
-
getDescription
public String getDescription()
.- Returns:
- description
-
setDescription
public void setDescription(String description)
setDescription.
-
folderId
public EnvelopeTemplateDefinition folderId(String folderId)
folderId.- Returns:
- EnvelopeTemplateDefinition
-
getFolderId
public String getFolderId()
The ID for the folder..- Returns:
- folderId
-
setFolderId
public void setFolderId(String folderId)
setFolderId.
-
folderName
public EnvelopeTemplateDefinition folderName(String folderName)
folderName.- Returns:
- EnvelopeTemplateDefinition
-
getFolderName
public String getFolderName()
The name of the folder in which the template is located..- Returns:
- folderName
-
setFolderName
public void setFolderName(String folderName)
setFolderName.
-
folderUri
public EnvelopeTemplateDefinition folderUri(String folderUri)
folderUri.- Returns:
- EnvelopeTemplateDefinition
-
getFolderUri
public String getFolderUri()
The URI of the folder..- Returns:
- folderUri
-
setFolderUri
public void setFolderUri(String folderUri)
setFolderUri.
-
lastModified
public EnvelopeTemplateDefinition lastModified(String lastModified)
lastModified.- Returns:
- EnvelopeTemplateDefinition
-
getLastModified
public String getLastModified()
.- Returns:
- lastModified
-
setLastModified
public void setLastModified(String lastModified)
setLastModified.
-
lastModifiedBy
public EnvelopeTemplateDefinition lastModifiedBy(UserInfo lastModifiedBy)
lastModifiedBy.- Returns:
- EnvelopeTemplateDefinition
-
getLastModifiedBy
public UserInfo getLastModifiedBy()
Get lastModifiedBy.- Returns:
- lastModifiedBy
-
setLastModifiedBy
public void setLastModifiedBy(UserInfo lastModifiedBy)
setLastModifiedBy.
-
name
public EnvelopeTemplateDefinition name(String name)
name.- Returns:
- EnvelopeTemplateDefinition
-
getName
public String getName()
.- Returns:
- name
-
setName
public void setName(String name)
setName.
-
newPassword
public EnvelopeTemplateDefinition newPassword(String newPassword)
newPassword.- Returns:
- EnvelopeTemplateDefinition
-
getNewPassword
public String getNewPassword()
.- Returns:
- newPassword
-
setNewPassword
public void setNewPassword(String newPassword)
setNewPassword.
-
owner
public EnvelopeTemplateDefinition owner(UserInfo owner)
owner.- Returns:
- EnvelopeTemplateDefinition
-
getOwner
public UserInfo getOwner()
Get owner.- Returns:
- owner
-
setOwner
public void setOwner(UserInfo owner)
setOwner.
-
pageCount
public EnvelopeTemplateDefinition pageCount(Integer pageCount)
pageCount.- Returns:
- EnvelopeTemplateDefinition
-
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)
setPageCount.
-
parentFolderUri
public EnvelopeTemplateDefinition parentFolderUri(String parentFolderUri)
parentFolderUri.- Returns:
- EnvelopeTemplateDefinition
-
getParentFolderUri
public String getParentFolderUri()
.- Returns:
- parentFolderUri
-
setParentFolderUri
public void setParentFolderUri(String parentFolderUri)
setParentFolderUri.
-
password
public EnvelopeTemplateDefinition password(String password)
password.- Returns:
- EnvelopeTemplateDefinition
-
getPassword
public String getPassword()
.- Returns:
- password
-
setPassword
public void setPassword(String password)
setPassword.
-
shared
public EnvelopeTemplateDefinition shared(String shared)
shared.- Returns:
- EnvelopeTemplateDefinition
-
getShared
public String getShared()
When set to **true**, this custom tab is shared..- Returns:
- shared
-
setShared
public void setShared(String shared)
setShared.
-
templateId
public EnvelopeTemplateDefinition templateId(String templateId)
templateId.- Returns:
- EnvelopeTemplateDefinition
-
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)
setTemplateId.
-
uri
public EnvelopeTemplateDefinition uri(String uri)
uri.- Returns:
- EnvelopeTemplateDefinition
-
getUri
public String getUri()
.- Returns:
- uri
-
setUri
public void setUri(String uri)
setUri.
-
equals
public boolean equals(Object o)
Compares objects.
-
-