Package com.docusign.esign.model

Class DocumentVisibility

java.lang.Object

com.docusign.esign.model.DocumentVisibility

public class DocumentVisibility
extends Object

This object configures a recipient's read/write access to a document..

Constructor Summary

Constructors

Constructor	Description
DocumentVisibility()

Method Summary

Modifier and Type	Method	Description
DocumentVisibility	documentId(String documentId)	documentId.
boolean	equals(Object o)	Compares objects.
DocumentVisibility	errorDetails(ErrorDetails errorDetails)	errorDetails.
String	getDocumentId()	Specifies the document ID number that the tab is placed on.
ErrorDetails	getErrorDetails()	This object describes errors that occur.
String	getRecipientId()	Unique for the recipient.
String	getRights()	.
String	getVisible()	.
int	hashCode()	Returns the HashCode.
DocumentVisibility	recipientId(String recipientId)	recipientId.
DocumentVisibility	rights(String rights)	rights.
void	setDocumentId(String documentId)	setDocumentId.
void	setErrorDetails(ErrorDetails errorDetails)	setErrorDetails.
void	setRecipientId(String recipientId)	setRecipientId.
void	setRights(String rights)	setRights.
void	setVisible(String visible)	setVisible.
String	toString()	Converts the given object to string.
DocumentVisibility	visible(String visible)	visible.

Methods inherited from class java.lang.Object

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

Constructor Detail

DocumentVisibility

public DocumentVisibility()

Method Detail

documentId

public DocumentVisibility documentId(String documentId)

documentId.

Returns:

DocumentVisibility

getDocumentId

public String getDocumentId()

Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute..

Returns:

documentId

setDocumentId

public void setDocumentId(String documentId)

setDocumentId.

errorDetails

public DocumentVisibility errorDetails(ErrorDetails errorDetails)

errorDetails.

Returns:

DocumentVisibility

getErrorDetails

public ErrorDetails getErrorDetails()

This object describes errors that occur. It is only valid for responses and ignored in requests..

Returns:

errorDetails

setErrorDetails

public void setErrorDetails(ErrorDetails errorDetails)

setErrorDetails.

recipientId

public DocumentVisibility recipientId(String recipientId)

recipientId.

Returns:

DocumentVisibility

getRecipientId

public String getRecipientId()

Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document..

Returns:

recipientId

setRecipientId

public void setRecipientId(String recipientId)

setRecipientId.

rights

public DocumentVisibility rights(String rights)

rights.

Returns:

DocumentVisibility

getRights

public String getRights()

.

Returns:

rights

setRights

public void setRights(String rights)

setRights.

visible

public DocumentVisibility visible(String visible)

visible.

Returns:

DocumentVisibility

getVisible

public String getVisible()

.

Returns:

visible

setVisible

public void setVisible(String visible)

setVisible.

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