Package com.broadleafcommerce.customer.domain

Class PaymentAccountSummary

  • All Implemented Interfaces:
    com.broadleafcommerce.data.tracking.core.ContextStateAware, com.broadleafcommerce.data.tracking.core.policy.Owned, Serializable
    public class PaymentAccountSummary
extends Object
implements Serializable, com.broadleafcommerce.data.tracking.core.ContextStateAware, com.broadleafcommerce.data.tracking.core.policy.Owned
    See Also:
    Serialized Form

    • Constructor Detail

      • PaymentAccountSummary

        public PaymentAccountSummary()

    • Method Detail

      • getOwnerIdentifier

        public String getOwnerIdentifier()
        Specified by:
        getOwnerIdentifier in interface com.broadleafcommerce.data.tracking.core.policy.Owned

      • getId

        public String getId()
        The context ID of the payment account.
        Returns:
        the context ID of the payment account

      • getCustomerRef

        public CustomerRef getCustomerRef()
        The customer associated with this payment account.
        Returns:
        the customer linked to the payment account

      • getDisplayName

        public String getDisplayName()
        The user-friendly name provided for the payment account.
        Returns:
        the display name of the payment account

      • getAccountType

        public String getAccountType()
        This represents the type of payment that is associated with this account.
        Returns:
        the account type of the payment account

      • getCardType

        public String getCardType()
        The specific card type, i.e. Visa, Mastercard, Discover, etc.
        Returns:
        the card type of the payment account

      • getGatewayType

        public String getGatewayType()
        The payment gateway associated with this payment account.
        Returns:
        the payment token gateway associated with the payment account

      • getDisplayAttributes

        public Map<String,​String> getDisplayAttributes()
        General use map to capture any display properties for the Payment
        Returns:
        General use map to capture any display properties for the Payment

      • getMaskedAccountNumber

        public String getMaskedAccountNumber()
        Partial information about the payment account, e.g. last four numbers of a credit card.
        Returns:

      • getNameOnAccount

        public String getNameOnAccount()
        The name associated with this payment account.
        Returns:
        the name on the payment account

      • getExpirationMonth

        public Integer getExpirationMonth()
        The month the payment gateway account associated with this payment account will expire.
        Returns:
        the expiration month of the payment account

      • getExpirationYear

        public Integer getExpirationYear()
        The year the payment gateway account associated with this payment account will expire.
        Returns:
        the expiration year of the payment account

      • getFullName

        public String getFullName()
        The combined names of the individual at this billing address. It is considered better UX to use a full name field in place of separate first and last name fields.
        Returns:
        The combined names of the individual at this address

      • getAddressLine1

        public String getAddressLine1()
        Primary address information associated with this payment account, typically street name and building number.
        Returns:
        the first address line for the payment account

      • getAddressLine2

        public String getAddressLine2()
        Secondary address information associated with this payment account, typically apartment, suite, or unit number.
        Returns:
        the second address line for the payment account

      • getAddressLine3

        public String getAddressLine3()
        Tertiary address information associated with this payment account, typically for international addresses.
        Returns:
        Tertiary address information, typically for international addresses.

      • getCity

        public String getCity()
        The city, town or village of this billing address.
        Returns:
        The city, town or village of this address.

      • getCounty

        public String getCounty()
        The county of this billing address.
        Returns:
        The county of this address.

      • getStateProvinceRegion

        public String getStateProvinceRegion()
        The state, province or region of this address.
        Returns:
        The state, province or region of this address.

      • getCountry

        public String getCountry()
        The country for this billing address.
        Returns:
        The country for this address.

      • getPostalCode

        public String getPostalCode()
        Postal code or ZIP code for this billing address.
        Returns:
        Postal code or ZIP code for this address.

      • getPhonePrimary

        public Phone getPhonePrimary()
        The primary phone number for this billing address.
        Returns:
        The primary phone number for this address.

      • getPhoneSecondary

        public Phone getPhoneSecondary()
        The secondary phone number for this billing address.
        Returns:
        The secondary phone number for this address.

      • getLastTransactionDateTime

        public Instant getLastTransactionDateTime()
        The timestamp of the last transaction made by this payment account.
        Returns:
        the last transaction date and time of the payment account

      • getLastTransactionResultCode

        public String getLastTransactionResultCode()
        The result code returned from the gateway on the last transaction.
        Returns:
        the result code from the last transaction for this payment account

      • isDeactivated

        public boolean isDeactivated()
        Whether this account is deactivated.
        Returns:
        Whether this account is deactivated.

      • getContextState

        public com.broadleafcommerce.data.tracking.core.filtering.business.domain.ContextState getContextState()
        A subset of Tracking information to expose the context state for this object.
        Specified by:
        getContextState in interface com.broadleafcommerce.data.tracking.core.ContextStateAware
        Returns:
        a subset of Tracking information to expose the context state for this object.

      • setId

        public void setId​(String id)
        The context ID of the payment account.
        Parameters:
        id - the context ID of the payment account

      • setCustomerRef

        public void setCustomerRef​(CustomerRef customerRef)
        The customer associated with this payment account.
        Parameters:
        customerRef - the customer linked to the payment account

      • setDisplayName

        public void setDisplayName​(String displayName)
        The user-friendly name provided for the payment account.
        Parameters:
        displayName - the display name of the payment account

      • setAccountType

        public void setAccountType​(String accountType)
        This represents the type of payment that is associated with this account.
        Parameters:
        accountType - the account type of the payment account

      • setCardType

        public void setCardType​(String cardType)
        The specific card type, i.e. Visa, Mastercard, Discover, etc.
        Parameters:
        cardType - the card type of the payment account

      • setGatewayType

        public void setGatewayType​(String gatewayType)
        The payment gateway associated with this payment account.
        Parameters:
        gatewayType - the payment token gateway associated with the payment account

      • setDisplayAttributes

        public void setDisplayAttributes​(Map<String,​String> displayAttributes)
        General use map to capture any display properties for the Payment
        Parameters:
        displayAttributes - General use map to capture any display properties for the Payment

      • setMaskedAccountNumber

        public void setMaskedAccountNumber​(String maskedAccountNumber)
        Partial information about the payment account, e.g. last four numbers of a credit card.
        Parameters:
        maskedAccountNumber -

      • setNameOnAccount

        public void setNameOnAccount​(String nameOnAccount)
        The name associated with this payment account.
        Parameters:
        nameOnAccount - the name on the payment account

      • setExpirationMonth

        public void setExpirationMonth​(Integer expirationMonth)
        The month the payment gateway account associated with this payment account will expire.
        Parameters:
        expirationMonth - the expiration month of the payment account

      • setExpirationYear

        public void setExpirationYear​(Integer expirationYear)
        The year the payment gateway account associated with this payment account will expire.
        Parameters:
        expirationYear - the expiration year of the payment account

      • setFullName

        public void setFullName​(String fullName)
        The combined names of the individual at this billing address. It is considered better UX to use a full name field in place of separate first and last name fields.
        Parameters:
        fullName - The combined names of the individual at this address

      • setAddressLine1

        public void setAddressLine1​(String addressLine1)
        Primary address information associated with this payment account, typically street name and building number.
        Parameters:
        addressLine1 - the first address line for the payment account

      • setAddressLine2

        public void setAddressLine2​(String addressLine2)
        Secondary address information associated with this payment account, typically apartment, suite, or unit number.
        Parameters:
        addressLine2 - the second address line for the payment account

      • setAddressLine3

        public void setAddressLine3​(String addressLine3)
        Tertiary address information associated with this payment account, typically for international addresses.
        Parameters:
        addressLine3 - Tertiary address information, typically for international addresses.

      • setCity

        public void setCity​(String city)
        The city, town or village of this billing address.
        Parameters:
        city - The city, town or village of this address.

      • setCounty

        public void setCounty​(String county)
        The county of this billing address.
        Parameters:
        county - The county of this address.

      • setStateProvinceRegion

        public void setStateProvinceRegion​(String stateProvinceRegion)
        The state, province or region of this address.
        Parameters:
        stateProvinceRegion - The state, province or region of this address.

      • setCountry

        public void setCountry​(String country)
        The country for this billing address.
        Parameters:
        country - The country for this address.

      • setPostalCode

        public void setPostalCode​(String postalCode)
        Postal code or ZIP code for this billing address.
        Parameters:
        postalCode - Postal code or ZIP code for this address.

      • setPhonePrimary

        public void setPhonePrimary​(Phone phonePrimary)
        The primary phone number for this billing address.
        Parameters:
        phonePrimary - The primary phone number for this address.

      • setPhoneSecondary

        public void setPhoneSecondary​(Phone phoneSecondary)
        The secondary phone number for this billing address.
        Parameters:
        phoneSecondary - The secondary phone number for this address.

      • setLastTransactionDateTime

        public void setLastTransactionDateTime​(Instant lastTransactionDateTime)
        The timestamp of the last transaction made by this payment account.
        Parameters:
        lastTransactionDateTime - the last transaction date and time of the payment account

      • setLastTransactionResultCode

        public void setLastTransactionResultCode​(String lastTransactionResultCode)
        The result code returned from the gateway on the last transaction.
        Parameters:
        lastTransactionResultCode - the result code from the last transaction for this payment account

      • setDeactivated

        public void setDeactivated​(boolean deactivated)
        Whether this account is deactivated.
        Parameters:
        deactivated - Whether this account is deactivated.

      • setContextState

        public void setContextState​(com.broadleafcommerce.data.tracking.core.filtering.business.domain.ContextState contextState)
        A subset of Tracking information to expose the context state for this object.
        Specified by:
        setContextState in interface com.broadleafcommerce.data.tracking.core.ContextStateAware
        Parameters:
        contextState - a subset of Tracking information to expose the context state for this object

      • canEqual

        protected boolean canEqual​(Object other)

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class Object