Package com.docusign.esign.model

Class LockRequest

  • public class LockRequest
extends Object
    This request object contains information about the lock that you want to create or update..

    • Constructor Detail

      • LockRequest

        public LockRequest()

    • Method Detail

      • lockDurationInSeconds

        public LockRequest lockDurationInSeconds​(String lockDurationInSeconds)
        lockDurationInSeconds.
        Returns:
        LockRequest

      • getLockDurationInSeconds

        public String getLockDurationInSeconds()
        The number of seconds to lock the envelope for editing. Must be greater than 0 seconds..
        Returns:
        lockDurationInSeconds

      • setLockDurationInSeconds

        public void setLockDurationInSeconds​(String lockDurationInSeconds)
        setLockDurationInSeconds.

      • lockedByApp

        public LockRequest lockedByApp​(String lockedByApp)
        lockedByApp.
        Returns:
        LockRequest

      • getLockedByApp

        public 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​(String lockedByApp)
        setLockedByApp.

      • lockType

        public LockRequest lockType​(String lockType)
        lockType.
        Returns:
        LockRequest

      • getLockType

        public String getLockType()
        The type of envelope lock. Currently \"edit\" is the only supported type..
        Returns:
        lockType

      • setLockType

        public void setLockType​(String lockType)
        setLockType.

      • templatePassword

        public LockRequest templatePassword​(String templatePassword)
        templatePassword.
        Returns:
        LockRequest

      • getTemplatePassword

        public String getTemplatePassword()
        .
        Returns:
        templatePassword

      • setTemplatePassword

        public void setTemplatePassword​(String templatePassword)
        setTemplatePassword.

      • useScratchPad

        public LockRequest useScratchPad​(String useScratchPad)
        useScratchPad.
        Returns:
        LockRequest

      • 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)
        setUseScratchPad.

      • 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