Class ConsumerDisclosure

    • Constructor Detail

      • ConsumerDisclosure

        public ConsumerDisclosure()
    • Method Detail

      • accountEsignId

        public ConsumerDisclosure accountEsignId​(String accountEsignId)
        accountEsignId.
        Returns:
        ConsumerDisclosure
      • getAccountEsignId

        public String getAccountEsignId()
        A GUID identifying the account associated with the consumer disclosure.
        Returns:
        accountEsignId
      • setAccountEsignId

        public void setAccountEsignId​(String accountEsignId)
        setAccountEsignId.
      • allowCDWithdraw

        public ConsumerDisclosure allowCDWithdraw​(String allowCDWithdraw)
        allowCDWithdraw.
        Returns:
        ConsumerDisclosure
      • getAllowCDWithdraw

        public String getAllowCDWithdraw()
        Indicates whether the customer can withdraw their acceptance of the consumer disclosure..
        Returns:
        allowCDWithdraw
      • setAllowCDWithdraw

        public void setAllowCDWithdraw​(String allowCDWithdraw)
        setAllowCDWithdraw.
      • allowCDWithdrawMetadata

        public ConsumerDisclosure allowCDWithdrawMetadata​(SettingsMetadata allowCDWithdrawMetadata)
        allowCDWithdrawMetadata.
        Returns:
        ConsumerDisclosure
      • getAllowCDWithdrawMetadata

        public SettingsMetadata getAllowCDWithdrawMetadata()
        Metadata that indicates whether the `allowCDWithdraw` property is editable. .
        Returns:
        allowCDWithdrawMetadata
      • setAllowCDWithdrawMetadata

        public void setAllowCDWithdrawMetadata​(SettingsMetadata allowCDWithdrawMetadata)
        setAllowCDWithdrawMetadata.
      • getChangeEmail

        public String getChangeEmail()
        .
        Returns:
        changeEmail
      • setChangeEmail

        public void setChangeEmail​(String changeEmail)
        setChangeEmail.
      • changeEmailOther

        public ConsumerDisclosure changeEmailOther​(String changeEmailOther)
        changeEmailOther.
        Returns:
        ConsumerDisclosure
      • getChangeEmailOther

        public String getChangeEmailOther()
        .
        Returns:
        changeEmailOther
      • setChangeEmailOther

        public void setChangeEmailOther​(String changeEmailOther)
        setChangeEmailOther.
      • getCompanyName

        public String getCompanyName()
        The name of the company associated with the consumer disclosure..
        Returns:
        companyName
      • setCompanyName

        public void setCompanyName​(String companyName)
        setCompanyName.
      • companyPhone

        public ConsumerDisclosure companyPhone​(String companyPhone)
        companyPhone.
        Returns:
        ConsumerDisclosure
      • getCompanyPhone

        public String getCompanyPhone()
        The phone number of the company associated with the consumer disclosure..
        Returns:
        companyPhone
      • setCompanyPhone

        public void setCompanyPhone​(String companyPhone)
        setCompanyPhone.
      • copyCostPerPage

        public ConsumerDisclosure copyCostPerPage​(String copyCostPerPage)
        copyCostPerPage.
        Returns:
        ConsumerDisclosure
      • getCopyCostPerPage

        public String getCopyCostPerPage()
        .
        Returns:
        copyCostPerPage
      • setCopyCostPerPage

        public void setCopyCostPerPage​(String copyCostPerPage)
        setCopyCostPerPage.
      • copyFeeCollectionMethod

        public ConsumerDisclosure copyFeeCollectionMethod​(String copyFeeCollectionMethod)
        copyFeeCollectionMethod.
        Returns:
        ConsumerDisclosure
      • getCopyFeeCollectionMethod

        public String getCopyFeeCollectionMethod()
        Specifies the fee collection method for cases in which the customer requires paper copies of the document. Maximum Length: 255 characters.
        Returns:
        copyFeeCollectionMethod
      • setCopyFeeCollectionMethod

        public void setCopyFeeCollectionMethod​(String copyFeeCollectionMethod)
        setCopyFeeCollectionMethod.
      • copyRequestEmail

        public ConsumerDisclosure copyRequestEmail​(String copyRequestEmail)
        copyRequestEmail.
        Returns:
        ConsumerDisclosure
      • getCopyRequestEmail

        public String getCopyRequestEmail()
        .
        Returns:
        copyRequestEmail
      • setCopyRequestEmail

        public void setCopyRequestEmail​(String copyRequestEmail)
        setCopyRequestEmail.
      • getCustom

        public String getCustom()
        .
        Returns:
        custom
      • setCustom

        public void setCustom​(String custom)
        setCustom.
      • getEnableEsign

        public String getEnableEsign()
        .
        Returns:
        enableEsign
      • setEnableEsign

        public void setEnableEsign​(String enableEsign)
        setEnableEsign.
      • esignAgreement

        public ConsumerDisclosure esignAgreement​(String esignAgreement)
        esignAgreement.
        Returns:
        ConsumerDisclosure
      • getEsignAgreement

        public String getEsignAgreement()
        The Electronic Record and Signature Disclosure text. The disclosure text includes the html formatting..
        Returns:
        esignAgreement
      • setEsignAgreement

        public void setEsignAgreement​(String esignAgreement)
        setEsignAgreement.
      • getEsignText

        public String getEsignText()
        .
        Returns:
        esignText
      • setEsignText

        public void setEsignText​(String esignText)
        setEsignText.
      • languageCode

        public ConsumerDisclosure languageCode​(String languageCode)
        languageCode.
        Returns:
        ConsumerDisclosure
      • getLanguageCode

        public String getLanguageCode()
        .
        Returns:
        languageCode
      • setLanguageCode

        public void setLanguageCode​(String languageCode)
        setLanguageCode.
      • mustAgreeToEsign

        public ConsumerDisclosure mustAgreeToEsign​(String mustAgreeToEsign)
        mustAgreeToEsign.
        Returns:
        ConsumerDisclosure
      • getMustAgreeToEsign

        public String getMustAgreeToEsign()
        .
        Returns:
        mustAgreeToEsign
      • setMustAgreeToEsign

        public void setMustAgreeToEsign​(String mustAgreeToEsign)
        setMustAgreeToEsign.
      • getPdfId

        public String getPdfId()
        .
        Returns:
        pdfId
      • setPdfId

        public void setPdfId​(String pdfId)
        setPdfId.
      • getUseBrand

        public String getUseBrand()
        .
        Returns:
        useBrand
      • setUseBrand

        public void setUseBrand​(String useBrand)
        setUseBrand.
      • useConsumerDisclosureWithinAccount

        public ConsumerDisclosure useConsumerDisclosureWithinAccount​(String useConsumerDisclosureWithinAccount)
        useConsumerDisclosureWithinAccount.
        Returns:
        ConsumerDisclosure
      • getUseConsumerDisclosureWithinAccount

        public String getUseConsumerDisclosureWithinAccount()
        .
        Returns:
        useConsumerDisclosureWithinAccount
      • setUseConsumerDisclosureWithinAccount

        public void setUseConsumerDisclosureWithinAccount​(String useConsumerDisclosureWithinAccount)
        setUseConsumerDisclosureWithinAccount.
      • useConsumerDisclosureWithinAccountMetadata

        public ConsumerDisclosure useConsumerDisclosureWithinAccountMetadata​(SettingsMetadata useConsumerDisclosureWithinAccountMetadata)
        useConsumerDisclosureWithinAccountMetadata.
        Returns:
        ConsumerDisclosure
      • getUseConsumerDisclosureWithinAccountMetadata

        public SettingsMetadata getUseConsumerDisclosureWithinAccountMetadata()
        Metadata that indicates whether the `useConsumerDisclosureWithinAccount` property is editable. .
        Returns:
        useConsumerDisclosureWithinAccountMetadata
      • setUseConsumerDisclosureWithinAccountMetadata

        public void setUseConsumerDisclosureWithinAccountMetadata​(SettingsMetadata useConsumerDisclosureWithinAccountMetadata)
        setUseConsumerDisclosureWithinAccountMetadata.
      • withdrawAddressLine1

        public ConsumerDisclosure withdrawAddressLine1​(String withdrawAddressLine1)
        withdrawAddressLine1.
        Returns:
        ConsumerDisclosure
      • getWithdrawAddressLine1

        public String getWithdrawAddressLine1()
        Contains the first address line of the postal address to which a customer can send a consent withdrawal notification. Maximum length: 100 characters. .
        Returns:
        withdrawAddressLine1
      • setWithdrawAddressLine1

        public void setWithdrawAddressLine1​(String withdrawAddressLine1)
        setWithdrawAddressLine1.
      • withdrawAddressLine2

        public ConsumerDisclosure withdrawAddressLine2​(String withdrawAddressLine2)
        withdrawAddressLine2.
        Returns:
        ConsumerDisclosure
      • getWithdrawAddressLine2

        public String getWithdrawAddressLine2()
        Contains the second address line of the postal address to which a customer can send a consent withdrawal notification. Maximum length: 100 characters. .
        Returns:
        withdrawAddressLine2
      • setWithdrawAddressLine2

        public void setWithdrawAddressLine2​(String withdrawAddressLine2)
        setWithdrawAddressLine2.
      • withdrawByEmail

        public ConsumerDisclosure withdrawByEmail​(String withdrawByEmail)
        withdrawByEmail.
        Returns:
        ConsumerDisclosure
      • getWithdrawByEmail

        public String getWithdrawByEmail()
        Indicates whether the customer can withdraw consent by email..
        Returns:
        withdrawByEmail
      • setWithdrawByEmail

        public void setWithdrawByEmail​(String withdrawByEmail)
        setWithdrawByEmail.
      • withdrawByMail

        public ConsumerDisclosure withdrawByMail​(String withdrawByMail)
        withdrawByMail.
        Returns:
        ConsumerDisclosure
      • getWithdrawByMail

        public String getWithdrawByMail()
        Indicates whether the customer can withdraw consent by postal mail..
        Returns:
        withdrawByMail
      • setWithdrawByMail

        public void setWithdrawByMail​(String withdrawByMail)
        setWithdrawByMail.
      • withdrawByPhone

        public ConsumerDisclosure withdrawByPhone​(String withdrawByPhone)
        withdrawByPhone.
        Returns:
        ConsumerDisclosure
      • getWithdrawByPhone

        public String getWithdrawByPhone()
        Indicates whether the customer can withdraw consent by phone..
        Returns:
        withdrawByPhone
      • setWithdrawByPhone

        public void setWithdrawByPhone​(String withdrawByPhone)
        setWithdrawByPhone.
      • withdrawCity

        public ConsumerDisclosure withdrawCity​(String withdrawCity)
        withdrawCity.
        Returns:
        ConsumerDisclosure
      • getWithdrawCity

        public String getWithdrawCity()
        Contains the city of the postal address to which a customer can send a consent withdrawal notification. Maximum length: 50 characters. .
        Returns:
        withdrawCity
      • setWithdrawCity

        public void setWithdrawCity​(String withdrawCity)
        setWithdrawCity.
      • withdrawConsequences

        public ConsumerDisclosure withdrawConsequences​(String withdrawConsequences)
        withdrawConsequences.
        Returns:
        ConsumerDisclosure
      • getWithdrawConsequences

        public String getWithdrawConsequences()
        Indicates the consequences of withdrawing consent..
        Returns:
        withdrawConsequences
      • setWithdrawConsequences

        public void setWithdrawConsequences​(String withdrawConsequences)
        setWithdrawConsequences.
      • withdrawEmail

        public ConsumerDisclosure withdrawEmail​(String withdrawEmail)
        withdrawEmail.
        Returns:
        ConsumerDisclosure
      • getWithdrawEmail

        public String getWithdrawEmail()
        Contains the email address to which a customer can send a consent withdrawal notification. Maximum length: 100 characters. .
        Returns:
        withdrawEmail
      • setWithdrawEmail

        public void setWithdrawEmail​(String withdrawEmail)
        setWithdrawEmail.
      • withdrawOther

        public ConsumerDisclosure withdrawOther​(String withdrawOther)
        withdrawOther.
        Returns:
        ConsumerDisclosure
      • getWithdrawOther

        public String getWithdrawOther()
        Indicates other information need to withdraw consent. Maximum length: 255 characters..
        Returns:
        withdrawOther
      • setWithdrawOther

        public void setWithdrawOther​(String withdrawOther)
        setWithdrawOther.
      • withdrawPhone

        public ConsumerDisclosure withdrawPhone​(String withdrawPhone)
        withdrawPhone.
        Returns:
        ConsumerDisclosure
      • getWithdrawPhone

        public String getWithdrawPhone()
        Contains the phone number which a customer can call to register consent withdrawal notification. Maximum length: 20 characters. .
        Returns:
        withdrawPhone
      • setWithdrawPhone

        public void setWithdrawPhone​(String withdrawPhone)
        setWithdrawPhone.
      • withdrawPostalCode

        public ConsumerDisclosure withdrawPostalCode​(String withdrawPostalCode)
        withdrawPostalCode.
        Returns:
        ConsumerDisclosure
      • getWithdrawPostalCode

        public String getWithdrawPostalCode()
        Contains the postal code of the postal address to which a customer can send a consent withdrawal notification. Maximum length: 20 characters. .
        Returns:
        withdrawPostalCode
      • setWithdrawPostalCode

        public void setWithdrawPostalCode​(String withdrawPostalCode)
        setWithdrawPostalCode.
      • withdrawState

        public ConsumerDisclosure withdrawState​(String withdrawState)
        withdrawState.
        Returns:
        ConsumerDisclosure
      • getWithdrawState

        public String getWithdrawState()
        Contains the state of the postal address to which a customer can send a consent withdrawal notification..
        Returns:
        withdrawState
      • setWithdrawState

        public void setWithdrawState​(String withdrawState)
        setWithdrawState.
      • 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