Package com.docusign.esign.model
Class LockRequest
- java.lang.Object
-
- com.docusign.esign.model.LockRequest
-
public class LockRequest extends java.lang.ObjectLockRequest.
-
-
Constructor Summary
Constructors Constructor Description LockRequest()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description booleanequals(java.lang.Object o)Compares objects.java.lang.StringgetLockDurationInSeconds()The number of seconds to lock the envelope for editing.java.lang.StringgetLockedByApp()A friendly name of the application used to lock the envelope.java.lang.StringgetLockType()The type of envelope lock.java.lang.StringgetTemplatePassword().java.lang.StringgetUseScratchPad()Reserved for future use.inthashCode()Returns the HashCode.LockRequestlockDurationInSeconds(java.lang.String lockDurationInSeconds)lockDurationInSeconds.LockRequestlockedByApp(java.lang.String lockedByApp)lockedByApp.LockRequestlockType(java.lang.String lockType)lockType.voidsetLockDurationInSeconds(java.lang.String lockDurationInSeconds)setLockDurationInSeconds.voidsetLockedByApp(java.lang.String lockedByApp)setLockedByApp.voidsetLockType(java.lang.String lockType)setLockType.voidsetTemplatePassword(java.lang.String templatePassword)setTemplatePassword.voidsetUseScratchPad(java.lang.String useScratchPad)setUseScratchPad.LockRequesttemplatePassword(java.lang.String templatePassword)templatePassword.java.lang.StringtoString()Converts the given object to string.LockRequestuseScratchPad(java.lang.String useScratchPad)useScratchPad.
-
-
-
Method Detail
-
lockDurationInSeconds
public LockRequest lockDurationInSeconds(java.lang.String lockDurationInSeconds)
lockDurationInSeconds.- Returns:
- LockRequest
-
getLockDurationInSeconds
public java.lang.String getLockDurationInSeconds()
The number of seconds to lock the envelope for editing. Must be greater than 0 seconds..- Returns:
- lockDurationInSeconds
-
setLockDurationInSeconds
public void setLockDurationInSeconds(java.lang.String lockDurationInSeconds)
setLockDurationInSeconds.
-
lockedByApp
public LockRequest lockedByApp(java.lang.String lockedByApp)
lockedByApp.- Returns:
- LockRequest
-
getLockedByApp
public java.lang.String getLockedByApp()
A friendly name of the application used to lock the envelope. Will be used in error messages to the user when lock conflicts occur..- Returns:
- lockedByApp
-
setLockedByApp
public void setLockedByApp(java.lang.String lockedByApp)
setLockedByApp.
-
lockType
public LockRequest lockType(java.lang.String lockType)
lockType.- Returns:
- LockRequest
-
getLockType
public java.lang.String getLockType()
The type of envelope lock. Currently \"edit\" is the only supported type..- Returns:
- lockType
-
setLockType
public void setLockType(java.lang.String lockType)
setLockType.
-
templatePassword
public LockRequest templatePassword(java.lang.String templatePassword)
templatePassword.- Returns:
- LockRequest
-
getTemplatePassword
public java.lang.String getTemplatePassword()
.- Returns:
- templatePassword
-
setTemplatePassword
public void setTemplatePassword(java.lang.String templatePassword)
setTemplatePassword.
-
useScratchPad
public LockRequest useScratchPad(java.lang.String useScratchPad)
useScratchPad.- Returns:
- LockRequest
-
getUseScratchPad
public java.lang.String getUseScratchPad()
Reserved for future use. Indicates whether a scratchpad is used for editing information. .- Returns:
- useScratchPad
-
setUseScratchPad
public void setUseScratchPad(java.lang.String useScratchPad)
setUseScratchPad.
-
equals
public boolean equals(java.lang.Object o)
Compares objects.- Overrides:
equalsin classjava.lang.Object- Returns:
- true or false depending on comparison result.
-
hashCode
public int hashCode()
Returns the HashCode.- Overrides:
hashCodein classjava.lang.Object
-
toString
public java.lang.String toString()
Converts the given object to string.- Overrides:
toStringin classjava.lang.Object
-
-