Package com.docusign.esign.model

Class LockInformation

  • public class LockInformation
extends java.lang.Object
    LockInformation.

    • Constructor Detail

      • LockInformation

        public LockInformation()

    • Method Detail

      • getErrorDetails

        public ErrorDetails getErrorDetails()
        Get errorDetails.
        Returns:
        errorDetails

      • setErrorDetails

        public void setErrorDetails​(ErrorDetails errorDetails)
        setErrorDetails.

      • lockDurationInSeconds

        public LockInformation lockDurationInSeconds​(java.lang.String lockDurationInSeconds)
        lockDurationInSeconds.
        Returns:
        LockInformation

      • getLockDurationInSeconds

        public java.lang.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​(java.lang.String lockDurationInSeconds)
        setLockDurationInSeconds.

      • lockedByApp

        public LockInformation lockedByApp​(java.lang.String lockedByApp)
        lockedByApp.
        Returns:
        LockInformation

      • getLockedByApp

        public java.lang.String getLockedByApp()
        Specifies the friendly name of the application that is locking the envelope..
        Returns:
        lockedByApp

      • setLockedByApp

        public void setLockedByApp​(java.lang.String lockedByApp)
        setLockedByApp.

      • lockedByUser

        public LockInformation lockedByUser​(UserInfo lockedByUser)
        lockedByUser.
        Returns:
        LockInformation

      • getLockedByUser

        public UserInfo getLockedByUser()
        Get lockedByUser.
        Returns:
        lockedByUser

      • setLockedByUser

        public void setLockedByUser​(UserInfo lockedByUser)
        setLockedByUser.

      • lockedUntilDateTime

        public LockInformation lockedUntilDateTime​(java.lang.String lockedUntilDateTime)
        lockedUntilDateTime.
        Returns:
        LockInformation

      • getLockedUntilDateTime

        public java.lang.String getLockedUntilDateTime()
        The datetime until the envelope lock expires..
        Returns:
        lockedUntilDateTime

      • setLockedUntilDateTime

        public void setLockedUntilDateTime​(java.lang.String lockedUntilDateTime)
        setLockedUntilDateTime.

      • lockToken

        public LockInformation lockToken​(java.lang.String lockToken)
        lockToken.
        Returns:
        LockInformation

      • getLockToken

        public java.lang.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​(java.lang.String lockToken)
        setLockToken.

      • lockType

        public LockInformation lockType​(java.lang.String lockType)
        lockType.
        Returns:
        LockInformation

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

      • useScratchPad

        public LockInformation useScratchPad​(java.lang.String useScratchPad)
        useScratchPad.
        Returns:
        LockInformation

      • 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:
        equals in class java.lang.Object
        Returns:
        true or false depending on comparison result.

      • hashCode

        public int hashCode()
        Returns the HashCode.
        Overrides:
        hashCode in class java.lang.Object

      • toString

        public java.lang.String toString()
        Converts the given object to string.
        Overrides:
        toString in class java.lang.Object