com.docusign.esign.model

Class FolderItem

java.lang.Object

com.docusign.esign.model.FolderItem

public class FolderItem
extends Object

FolderItem

Constructor Summary

Constructors

Constructor and Description
FolderItem()

Method Summary

Methods

Modifier and Type	Method and Description
FolderItem	addCustomFieldsItem(CustomFieldV2 customFieldsItem)
FolderItem	completedDateTime(String completedDateTime)
FolderItem	createdDateTime(String createdDateTime)
FolderItem	customFields(List<CustomFieldV2> customFields)
FolderItem	description(String description)
FolderItem	envelopeId(String envelopeId)
FolderItem	envelopeUri(String envelopeUri)
boolean	equals(Object o)
String	getCompletedDateTime() Specifies the date and time this item was completed.
String	getCreatedDateTime() Indicates the date and time the item was created.
List<CustomFieldV2>	getCustomFields() An optional array of strings that allows the sender to provide custom data about the recipient.
String	getDescription()
String	getEnvelopeId() The envelope ID of the envelope status that failed to post.
String	getEnvelopeUri() Contains a URI for an endpoint that you can use to retrieve the envelope or envelopes.
String	getIs21CFRPart11() When set to **true**, indicates that this module is enabled on the account.
String	getIsSignatureProviderEnvelope()
String	getLastModified()
String	getName()
String	getOwnerName() Name of the envelope owner.
Integer	getPageCount()
String	getPassword()
String	getSenderEmail()
String	getSenderName() Name of the envelope sender.
String	getSentDateTime() The date and time the envelope was sent.
String	getShared() When set to **true**, this custom tab is shared.
String	getStatus() Indicates the envelope status.
String	getSubject()
String	getTemplateId() The unique identifier of the template.
String	getUri()
int	hashCode()
FolderItem	is21CFRPart11(String is21CFRPart11)
FolderItem	isSignatureProviderEnvelope(String isSignatureProviderEnvelope)
FolderItem	lastModified(String lastModified)
FolderItem	name(String name)
FolderItem	ownerName(String ownerName)
FolderItem	pageCount(Integer pageCount)
FolderItem	password(String password)
FolderItem	senderEmail(String senderEmail)
FolderItem	senderName(String senderName)
FolderItem	sentDateTime(String sentDateTime)
void	setCompletedDateTime(String completedDateTime)
void	setCreatedDateTime(String createdDateTime)
void	setCustomFields(List<CustomFieldV2> customFields)
void	setDescription(String description)
void	setEnvelopeId(String envelopeId)
void	setEnvelopeUri(String envelopeUri)
void	setIs21CFRPart11(String is21CFRPart11)
void	setIsSignatureProviderEnvelope(String isSignatureProviderEnvelope)
void	setLastModified(String lastModified)
void	setName(String name)
void	setOwnerName(String ownerName)
void	setPageCount(Integer pageCount)
void	setPassword(String password)
void	setSenderEmail(String senderEmail)
void	setSenderName(String senderName)
void	setSentDateTime(String sentDateTime)
void	setShared(String shared)
void	setStatus(String status)
void	setSubject(String subject)
void	setTemplateId(String templateId)
void	setUri(String uri)
FolderItem	shared(String shared)
FolderItem	status(String status)
FolderItem	subject(String subject)
FolderItem	templateId(String templateId)
String	toString()
FolderItem	uri(String uri)

Methods inherited from class java.lang.Object

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

Constructor Detail

FolderItem

public FolderItem()

Method Detail

completedDateTime

public FolderItem completedDateTime(String completedDateTime)

getCompletedDateTime

public String getCompletedDateTime()

Specifies the date and time this item was completed.

Returns:

completedDateTime

setCompletedDateTime

public void setCompletedDateTime(String completedDateTime)

createdDateTime

public FolderItem createdDateTime(String createdDateTime)

getCreatedDateTime

public String getCreatedDateTime()

Indicates the date and time the item was created.

Returns:

createdDateTime

setCreatedDateTime

public void setCreatedDateTime(String createdDateTime)

customFields

public FolderItem customFields(List<CustomFieldV2> customFields)

addCustomFieldsItem

public FolderItem addCustomFieldsItem(CustomFieldV2 customFieldsItem)

getCustomFields

public List<CustomFieldV2> getCustomFields()

An optional array of strings that allows the sender to provide custom data about the recipient. This information is returned in the envelope status but otherwise not used by DocuSign. Each customField string can be a maximum of 100 characters.

Returns:

customFields

setCustomFields

public void setCustomFields(List<CustomFieldV2> customFields)

description

public FolderItem description(String description)

getDescription

public String getDescription()

Returns:

description

setDescription

public void setDescription(String description)

envelopeId

public FolderItem envelopeId(String envelopeId)

getEnvelopeId

public String getEnvelopeId()

The envelope ID of the envelope status that failed to post.

Returns:

envelopeId

setEnvelopeId

public void setEnvelopeId(String envelopeId)

envelopeUri

public FolderItem envelopeUri(String envelopeUri)

getEnvelopeUri

public String getEnvelopeUri()

Contains a URI for an endpoint that you can use to retrieve the envelope or envelopes.

Returns:

envelopeUri

setEnvelopeUri

public void setEnvelopeUri(String envelopeUri)

is21CFRPart11

public FolderItem is21CFRPart11(String is21CFRPart11)

getIs21CFRPart11

public String getIs21CFRPart11()

When set to **true**, indicates that this module is enabled on the account.

Returns:

is21CFRPart11

setIs21CFRPart11

public void setIs21CFRPart11(String is21CFRPart11)

isSignatureProviderEnvelope

public FolderItem isSignatureProviderEnvelope(String isSignatureProviderEnvelope)

getIsSignatureProviderEnvelope

public String getIsSignatureProviderEnvelope()

Returns:

isSignatureProviderEnvelope

setIsSignatureProviderEnvelope

public void setIsSignatureProviderEnvelope(String isSignatureProviderEnvelope)

lastModified

public FolderItem lastModified(String lastModified)

getLastModified

public String getLastModified()

Returns:

lastModified

setLastModified

public void setLastModified(String lastModified)

name

public FolderItem name(String name)

getName

public String getName()

Returns:

name

setName

public void setName(String name)

ownerName

public FolderItem ownerName(String ownerName)

getOwnerName

public String getOwnerName()

Name of the envelope owner.

Returns:

ownerName

setOwnerName

public void setOwnerName(String ownerName)

pageCount

public FolderItem pageCount(Integer pageCount)

getPageCount

public Integer getPageCount()

Returns:

pageCount

setPageCount

public void setPageCount(Integer pageCount)

password

public FolderItem password(String password)

getPassword

public String getPassword()

Returns:

password

setPassword

public void setPassword(String password)

senderEmail

public FolderItem senderEmail(String senderEmail)

getSenderEmail

public String getSenderEmail()

Returns:

senderEmail

setSenderEmail

public void setSenderEmail(String senderEmail)

senderName

public FolderItem senderName(String senderName)

getSenderName

public String getSenderName()

Name of the envelope sender.

Returns:

senderName

setSenderName

public void setSenderName(String senderName)

sentDateTime

public FolderItem sentDateTime(String sentDateTime)

getSentDateTime

public String getSentDateTime()

The date and time the envelope was sent.

Returns:

sentDateTime

setSentDateTime

public void setSentDateTime(String sentDateTime)

shared

public FolderItem shared(String shared)

getShared

public String getShared()

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

Returns:

shared

setShared

public void setShared(String shared)

status

public FolderItem status(String status)

getStatus

public String getStatus()

Indicates the envelope status. Valid values are: * sent - The envelope is sent to the recipients. * created - The envelope is saved as a draft and can be modified and sent later.

Returns:

status

setStatus

public void setStatus(String status)

subject

public FolderItem subject(String subject)

getSubject

public String getSubject()

Returns:

subject

setSubject

public void setSubject(String subject)

templateId

public FolderItem 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 FolderItem 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