Package com.docusign.esign.model

Class AccessCodeFormat

  • public class AccessCodeFormat
extends Object
    Object specifying the format of the string provided to a recipient in order to access an envelope..

    • Constructor Detail

      • AccessCodeFormat

        public AccessCodeFormat()

    • Method Detail

      • formatRequired

        public AccessCodeFormat formatRequired​(String formatRequired)
        formatRequired.
        Returns:
        AccessCodeFormat

      • getFormatRequired

        public String getFormatRequired()
        .
        Returns:
        formatRequired

      • setFormatRequired

        public void setFormatRequired​(String formatRequired)
        setFormatRequired.

      • formatRequiredMetadata

        public AccessCodeFormat formatRequiredMetadata​(SettingsMetadata formatRequiredMetadata)
        formatRequiredMetadata.
        Returns:
        AccessCodeFormat

      • getFormatRequiredMetadata

        public SettingsMetadata getFormatRequiredMetadata()
        Metadata indicating whether the `formatRequired` property is editable..
        Returns:
        formatRequiredMetadata

      • setFormatRequiredMetadata

        public void setFormatRequiredMetadata​(SettingsMetadata formatRequiredMetadata)
        setFormatRequiredMetadata.

      • letterRequired

        public AccessCodeFormat letterRequired​(String letterRequired)
        letterRequired.
        Returns:
        AccessCodeFormat

      • getLetterRequired

        public String getLetterRequired()
        .
        Returns:
        letterRequired

      • setLetterRequired

        public void setLetterRequired​(String letterRequired)
        setLetterRequired.

      • letterRequiredMetadata

        public AccessCodeFormat letterRequiredMetadata​(SettingsMetadata letterRequiredMetadata)
        letterRequiredMetadata.
        Returns:
        AccessCodeFormat

      • getLetterRequiredMetadata

        public SettingsMetadata getLetterRequiredMetadata()
        Metadata indicating whether the `letterRequired` property is editable..
        Returns:
        letterRequiredMetadata

      • setLetterRequiredMetadata

        public void setLetterRequiredMetadata​(SettingsMetadata letterRequiredMetadata)
        setLetterRequiredMetadata.

      • minimumLength

        public AccessCodeFormat minimumLength​(String minimumLength)
        minimumLength.
        Returns:
        AccessCodeFormat

      • getMinimumLength

        public String getMinimumLength()
        .
        Returns:
        minimumLength

      • setMinimumLength

        public void setMinimumLength​(String minimumLength)
        setMinimumLength.

      • minimumLengthMetadata

        public AccessCodeFormat minimumLengthMetadata​(SettingsMetadata minimumLengthMetadata)
        minimumLengthMetadata.
        Returns:
        AccessCodeFormat

      • getMinimumLengthMetadata

        public SettingsMetadata getMinimumLengthMetadata()
        Metadata indicating whether the `minimumLength` property is editable..
        Returns:
        minimumLengthMetadata

      • setMinimumLengthMetadata

        public void setMinimumLengthMetadata​(SettingsMetadata minimumLengthMetadata)
        setMinimumLengthMetadata.

      • numberRequired

        public AccessCodeFormat numberRequired​(String numberRequired)
        numberRequired.
        Returns:
        AccessCodeFormat

      • getNumberRequired

        public String getNumberRequired()
        .
        Returns:
        numberRequired

      • setNumberRequired

        public void setNumberRequired​(String numberRequired)
        setNumberRequired.

      • numberRequiredMetadata

        public AccessCodeFormat numberRequiredMetadata​(SettingsMetadata numberRequiredMetadata)
        numberRequiredMetadata.
        Returns:
        AccessCodeFormat

      • getNumberRequiredMetadata

        public SettingsMetadata getNumberRequiredMetadata()
        Metadata indicating whether the `numberRequired` property is editable..
        Returns:
        numberRequiredMetadata

      • setNumberRequiredMetadata

        public void setNumberRequiredMetadata​(SettingsMetadata numberRequiredMetadata)
        setNumberRequiredMetadata.

      • specialCharacterRequired

        public AccessCodeFormat specialCharacterRequired​(String specialCharacterRequired)
        specialCharacterRequired.
        Returns:
        AccessCodeFormat

      • getSpecialCharacterRequired

        public String getSpecialCharacterRequired()
        .
        Returns:
        specialCharacterRequired

      • setSpecialCharacterRequired

        public void setSpecialCharacterRequired​(String specialCharacterRequired)
        setSpecialCharacterRequired.

      • specialCharacterRequiredMetadata

        public AccessCodeFormat specialCharacterRequiredMetadata​(SettingsMetadata specialCharacterRequiredMetadata)
        specialCharacterRequiredMetadata.
        Returns:
        AccessCodeFormat

      • getSpecialCharacterRequiredMetadata

        public SettingsMetadata getSpecialCharacterRequiredMetadata()
        Metadata indicating whether the `specialCharacterRequired` property is editable..
        Returns:
        specialCharacterRequiredMetadata

      • setSpecialCharacterRequiredMetadata

        public void setSpecialCharacterRequiredMetadata​(SettingsMetadata specialCharacterRequiredMetadata)
        setSpecialCharacterRequiredMetadata.

      • 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