com.docusign.esign.model

Class LockInformation

java.lang.Object

com.docusign.esign.model.LockInformation

public class LockInformation
extends Object

LockInformation

Constructor Summary

Constructors

Constructor and Description
LockInformation()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object o)
LockInformation	errorDetails(ErrorDetails errorDetails)
ErrorDetails	getErrorDetails() Get errorDetails
String	getLockDurationInSeconds() Sets the time, in seconds, until the lock expires when there is no activity on the envelope.
String	getLockedByApp() Specifies the friendly name of the application that is locking the envelope.
UserInfo	getLockedByUser() Get lockedByUser
String	getLockedUntilDateTime() The datetime until the envelope lock expires.
String	getLockToken() A unique identifier provided to the owner of the envelope lock.
String	getLockType() The type of envelope lock.
String	getUseScratchPad() Reserved for future use.
int	hashCode()
LockInformation	lockDurationInSeconds(String lockDurationInSeconds)
LockInformation	lockedByApp(String lockedByApp)
LockInformation	lockedByUser(UserInfo lockedByUser)
LockInformation	lockedUntilDateTime(String lockedUntilDateTime)
LockInformation	lockToken(String lockToken)
LockInformation	lockType(String lockType)
void	setErrorDetails(ErrorDetails errorDetails)
void	setLockDurationInSeconds(String lockDurationInSeconds)
void	setLockedByApp(String lockedByApp)
void	setLockedByUser(UserInfo lockedByUser)
void	setLockedUntilDateTime(String lockedUntilDateTime)
void	setLockToken(String lockToken)
void	setLockType(String lockType)
void	setUseScratchPad(String useScratchPad)
String	toString()
LockInformation	useScratchPad(String useScratchPad)

Methods inherited from class java.lang.Object

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

Constructor Detail

LockInformation

public LockInformation()

Method Detail

errorDetails

public LockInformation errorDetails(ErrorDetails errorDetails)

getErrorDetails

public ErrorDetails getErrorDetails()

Get errorDetails

Returns:

errorDetails

setErrorDetails

public void setErrorDetails(ErrorDetails errorDetails)

lockDurationInSeconds

public LockInformation lockDurationInSeconds(String lockDurationInSeconds)

getLockDurationInSeconds

public String getLockDurationInSeconds()

Sets the time, in seconds, until the lock expires when there is no activity on the envelope. If no value is entered, then the default value of 300 seconds is used. The maximum value is 1,800 seconds. The lock duration can be extended.

Returns:

lockDurationInSeconds

setLockDurationInSeconds

public void setLockDurationInSeconds(String lockDurationInSeconds)

lockedByApp

public LockInformation lockedByApp(String lockedByApp)

getLockedByApp

public String getLockedByApp()

Specifies the friendly name of the application that is locking the envelope.

Returns:

lockedByApp

setLockedByApp

public void setLockedByApp(String lockedByApp)

lockedByUser

public LockInformation lockedByUser(UserInfo lockedByUser)

getLockedByUser

public UserInfo getLockedByUser()

Get lockedByUser

Returns:

lockedByUser

setLockedByUser

public void setLockedByUser(UserInfo lockedByUser)

lockedUntilDateTime

public LockInformation lockedUntilDateTime(String lockedUntilDateTime)

getLockedUntilDateTime

public String getLockedUntilDateTime()

The datetime until the envelope lock expires.

Returns:

lockedUntilDateTime

setLockedUntilDateTime

public void setLockedUntilDateTime(String lockedUntilDateTime)

lockToken

public LockInformation lockToken(String lockToken)

getLockToken

public String getLockToken()

A unique identifier provided to the owner of the envelope lock. Used to prove ownership of the lock.

Returns:

lockToken

setLockToken

public void setLockToken(String lockToken)

lockType

public LockInformation lockType(String lockType)

getLockType

public String getLockType()

The type of envelope lock. Currently \"edit\" is the only supported type.

Returns:

lockType

setLockType

public void setLockType(String lockType)

useScratchPad

public LockInformation useScratchPad(String useScratchPad)

getUseScratchPad

public String getUseScratchPad()

Reserved for future use. Indicates whether a scratchpad is used for editing information.

Returns:

useScratchPad

setUseScratchPad

public void setUseScratchPad(String useScratchPad)

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