Package com.broadleafcommerce.customer.service.provider.domain

Class Payment

  • All Implemented Interfaces:
    com.broadleafcommerce.data.tracking.core.ContextStateAware, Serializable
    @Deprecated(since="1.7.2",
            forRemoval=true)
public class Payment
extends Object
implements Serializable, com.broadleafcommerce.data.tracking.core.ContextStateAware
    Deprecated, for removal: This API element is subject to removal in a future version.
    since 1.7.2, in favor of using PaymentTransactionServices as saved payment method storage location.

    This entity is designed to store payment methods associated to a Cart.

    Author:
    Chad Harchar (charchar), Chris Kittrell (ckittrell)
    See Also:
    Serialized Form

    • Constructor Summary

      Constructors 
      Constructor Description
      Payment()
      Deprecated, for removal: This API element is subject to removal in a future version.
       

    • Method Summary

      All Methods Instance Methods Concrete Methods Deprecated Methods 
      Modifier and Type Method Description
      protected boolean canEqual​(Object other)
      Deprecated, for removal: This API element is subject to removal in a future version.
       
      boolean equals​(Object o)
      Deprecated, for removal: This API element is subject to removal in a future version.
       
      Map<String,​Address> getAddressByType()
      Deprecated, for removal: This API element is subject to removal in a future version.
      The collection of related addresses that may include billing or shipping addresses
      Map<String,​String> getAttributes()
      Deprecated, for removal: This API element is subject to removal in a future version.
      General use map to capture any additional attributes needed for this Payment
      Address getBillingAddress()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Gathers one of the payment's related addresses by type
      com.broadleafcommerce.data.tracking.core.filtering.business.domain.ContextState getContextState()
      Deprecated, for removal: This API element is subject to removal in a future version.
      A subset of Tracking information to expose the context state for this object.
      CustomerRef getCustomerRef()
      Deprecated, for removal: This API element is subject to removal in a future version.
      A reference to the customer that owns this payment.
      Map<String,​String> getDisplayAttributes()
      Deprecated, for removal: This API element is subject to removal in a future version.
      General use map to capture any display properties for this Payment
      String getGatewayType()
      Deprecated, for removal: This API element is subject to removal in a future version.
      The gateway used to process this payment.
      String getId()
      Deprecated, for removal: This API element is subject to removal in a future version.
      The id of this payment.
      String getName()
      Deprecated, for removal: This API element is subject to removal in a future version.
      The name of this payment.
      String getOwnerId()
      Deprecated, for removal: This API element is subject to removal in a future version.
      The id of the entity that owns this payment.
      String getOwnerType()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Describes the owner of the payment.
      Map<String,​String> getPaymentMethodProperties()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Map to capture any information about the payment method needed to perform gateway transactions
      boolean getShouldSavePaymentForFutureUse()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Should the payment method be saved to the owning user
      boolean getShouldSavePaymentToCustomer()
      Deprecated, for removal: This API element is subject to removal in a future version.
      since 1.7.2, in favor of getShouldSavePaymentForFutureUse() to support owning user types other than a customer (i.e.
      List<PaymentTransaction> getTransactions()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Transaction data representing each payment gateway interaction related to this payment.
      String getType()
      Deprecated, for removal: This API element is subject to removal in a future version.
      The type of this payment like Credit Card or Gift Card.
      int hashCode()
      Deprecated, for removal: This API element is subject to removal in a future version.
       
      void setAddressByType​(Map<String,​Address> addressByType)
      Deprecated, for removal: This API element is subject to removal in a future version.
      The collection of related addresses that may include billing or shipping addresses
      void setAttributes​(Map<String,​String> attributes)
      Deprecated, for removal: This API element is subject to removal in a future version.
      General use map to capture any additional attributes needed for this Payment
      void setContextState​(com.broadleafcommerce.data.tracking.core.filtering.business.domain.ContextState contextState)
      Deprecated, for removal: This API element is subject to removal in a future version.
      A subset of Tracking information to expose the context state for this object.
      void setCustomerRef​(CustomerRef customerRef)
      Deprecated, for removal: This API element is subject to removal in a future version.
      A reference to the customer that owns this payment.
      void setDisplayAttributes​(Map<String,​String> displayAttributes)
      Deprecated, for removal: This API element is subject to removal in a future version.
      General use map to capture any display properties for this Payment
      void setGatewayType​(String gatewayType)
      Deprecated, for removal: This API element is subject to removal in a future version.
      The gateway used to process this payment.
      void setId​(String id)
      Deprecated, for removal: This API element is subject to removal in a future version.
      The id of this payment.
      void setName​(String name)
      Deprecated, for removal: This API element is subject to removal in a future version.
      The name of this payment.
      void setOwnerId​(String ownerId)
      Deprecated, for removal: This API element is subject to removal in a future version.
      The id of the entity that owns this payment.
      void setOwnerType​(String ownerType)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Describes the owner of the payment.
      void setPaymentMethodProperties​(Map<String,​String> paymentMethodProperties)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Map to capture any information about the payment method needed to perform gateway transactions
      void setShouldSavePaymentForFutureUse​(boolean shouldSavePaymentForFutureUse)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Should the payment method be saved to the owning user.
      void setShouldSavePaymentToCustomer​(boolean shouldSavePaymentToCustomer)
      Deprecated.
      since 1.7.2, in favor of shouldSavePaymentForFutureUse to support owning user types other than a customer (i.e.
      void setTransactions​(List<PaymentTransaction> transactions)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Transaction data representing each payment gateway interaction related to this payment.
      void setType​(String type)
      Deprecated, for removal: This API element is subject to removal in a future version.
      The type of this payment like Credit Card or Gift Card.
      String toString()
      Deprecated, for removal: This API element is subject to removal in a future version.
       

    • Constructor Detail

      • Payment

        public Payment()
        Deprecated, for removal: This API element is subject to removal in a future version.

    • Method Detail

      • getBillingAddress

        @Nullable
public Address getBillingAddress()
        Deprecated, for removal: This API element is subject to removal in a future version.
        Gathers one of the payment's related addresses by type
        Returns:
        The payment's related address identified by type

      • getShouldSavePaymentToCustomer

        @Deprecated(since="1.7.2",
            forRemoval=true)
public boolean getShouldSavePaymentToCustomer()
        Deprecated, for removal: This API element is subject to removal in a future version.
        since 1.7.2, in favor of getShouldSavePaymentForFutureUse() to support owning user types other than a customer (i.e. account).

      • getShouldSavePaymentForFutureUse

        public boolean getShouldSavePaymentForFutureUse()
        Deprecated, for removal: This API element is subject to removal in a future version.
        Should the payment method be saved to the owning user
        Returns:
        Should the payment method be saved to the owning user

      • getId

        public String getId()
        Deprecated, for removal: This API element is subject to removal in a future version.
        The id of this payment.
        Returns:
        The id of this payment.

      • getName

        public String getName()
        Deprecated, for removal: This API element is subject to removal in a future version.
        The name of this payment. This name is typically something like "Visa ending in 1234".
        Returns:
        The name of this payment.

      • getOwnerType

        public String getOwnerType()
        Deprecated, for removal: This API element is subject to removal in a future version.
        Describes the owner of the payment. For example, the payment could have originated with a cart or a subscription, therefore this value might be CART or SUBSCRIPTION.
        Returns:
        The type describing the owner of the payment

      • getOwnerId

        public String getOwnerId()
        Deprecated, for removal: This API element is subject to removal in a future version.
        The id of the entity that owns this payment. For example, this may be a cart id, or a subscription billing cycle id.
        Returns:
        The id of the entity that owns this payment.

      • getCustomerRef

        public CustomerRef getCustomerRef()
        Deprecated, for removal: This API element is subject to removal in a future version.
        A reference to the customer that owns this payment.
        Returns:
        A reference to the customer that owns this payment.

      • getType

        public String getType()
        Deprecated, for removal: This API element is subject to removal in a future version.
        The type of this payment like Credit Card or Gift Card.
        Returns:
        The type of this payment like Credit Card or Gift Card.

      • getGatewayType

        public String getGatewayType()
        Deprecated, for removal: This API element is subject to removal in a future version.
        The gateway used to process this payment. Only a SINGLE payment gateway can modify transactions on a particular payment.
        Returns:
        The gateway used to process this payment.

      • getAddressByType

        public Map<String,​Address> getAddressByType()
        Deprecated, for removal: This API element is subject to removal in a future version.
        The collection of related addresses that may include billing or shipping addresses
        Returns:
        The collection of related addresses

      • getPaymentMethodProperties

        public Map<String,​String> getPaymentMethodProperties()
        Deprecated, for removal: This API element is subject to removal in a future version.
        Map to capture any information about the payment method needed to perform gateway transactions
        Returns:
        Map to capture any information about the payment method needed to perform gateway transactions

      • getAttributes

        public Map<String,​String> getAttributes()
        Deprecated, for removal: This API element is subject to removal in a future version.
        General use map to capture any additional attributes needed for this Payment
        Returns:
        General use map to capture any additional attributes needed for this Payment

      • getDisplayAttributes

        public Map<String,​String> getDisplayAttributes()
        Deprecated, for removal: This API element is subject to removal in a future version.
        General use map to capture any display properties for this Payment
        Returns:
        General use map to capture any display properties for this Payment

      • getTransactions

        public List<PaymentTransaction> getTransactions()
        Deprecated, for removal: This API element is subject to removal in a future version.
        Transaction data representing each payment gateway interaction related to this payment.
        Returns:
        Transactions related to this payment.

      • getContextState

        public com.broadleafcommerce.data.tracking.core.filtering.business.domain.ContextState getContextState()
        Deprecated, for removal: This API element is subject to removal in a future version.
        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)
        Deprecated, for removal: This API element is subject to removal in a future version.
        The id of this payment.
        Parameters:
        id - The id of this payment.

      • setName

        public void setName​(String name)
        Deprecated, for removal: This API element is subject to removal in a future version.
        The name of this payment. This name is typically something like "Visa ending in 1234".
        Parameters:
        name - The name of this payment.

      • setOwnerType

        public void setOwnerType​(String ownerType)
        Deprecated, for removal: This API element is subject to removal in a future version.
        Describes the owner of the payment. For example, the payment could have originated with a cart or a subscription, therefore this value might be CART or SUBSCRIPTION.
        Parameters:
        ownerType - The type describing the owner of the payment

      • setOwnerId

        public void setOwnerId​(String ownerId)
        Deprecated, for removal: This API element is subject to removal in a future version.
        The id of the entity that owns this payment. For example, this may be a cart id, or a subscription billing cycle id.
        Parameters:
        ownerId - The id of the entity that owns this payment.

      • setCustomerRef

        public void setCustomerRef​(CustomerRef customerRef)
        Deprecated, for removal: This API element is subject to removal in a future version.
        A reference to the customer that owns this payment.
        Parameters:
        customerRef - A reference to the customer that owns this payment.

      • setType

        public void setType​(String type)
        Deprecated, for removal: This API element is subject to removal in a future version.
        The type of this payment like Credit Card or Gift Card.
        Parameters:
        type - The type of this payment like Credit Card or Gift Card.

      • setGatewayType

        public void setGatewayType​(String gatewayType)
        Deprecated, for removal: This API element is subject to removal in a future version.
        The gateway used to process this payment. Only a SINGLE payment gateway can modify transactions on a particular payment.
        Parameters:
        gatewayType - The gateway used to process this payment.

      • setAddressByType

        public void setAddressByType​(Map<String,​Address> addressByType)
        Deprecated, for removal: This API element is subject to removal in a future version.
        The collection of related addresses that may include billing or shipping addresses
        Parameters:
        addressByType - The collection of related addresses

      • setPaymentMethodProperties

        public void setPaymentMethodProperties​(Map<String,​String> paymentMethodProperties)
        Deprecated, for removal: This API element is subject to removal in a future version.
        Map to capture any information about the payment method needed to perform gateway transactions
        Parameters:
        paymentMethodProperties - Map to capture any information about the payment method needed to perform gateway transactions

      • setAttributes

        public void setAttributes​(Map<String,​String> attributes)
        Deprecated, for removal: This API element is subject to removal in a future version.
        General use map to capture any additional attributes needed for this Payment
        Parameters:
        attributes - General use map to capture any additional attributes needed for this Payment

      • setDisplayAttributes

        public void setDisplayAttributes​(Map<String,​String> displayAttributes)
        Deprecated, for removal: This API element is subject to removal in a future version.
        General use map to capture any display properties for this Payment
        Parameters:
        displayAttributes - General use map to capture any display properties for this Payment

      • setShouldSavePaymentToCustomer

        @Deprecated
public void setShouldSavePaymentToCustomer​(boolean shouldSavePaymentToCustomer)
        Deprecated.
        since 1.7.2, in favor of shouldSavePaymentForFutureUse to support owning user types other than a customer (i.e. account).

      • setShouldSavePaymentForFutureUse

        public void setShouldSavePaymentForFutureUse​(boolean shouldSavePaymentForFutureUse)
        Deprecated, for removal: This API element is subject to removal in a future version.
        Should the payment method be saved to the owning user.
        Parameters:
        shouldSavePaymentForFutureUse - Should the payment method be saved to the owning user

      • setTransactions

        public void setTransactions​(List<PaymentTransaction> transactions)
        Deprecated, for removal: This API element is subject to removal in a future version.
        Transaction data representing each payment gateway interaction related to this payment.
        Parameters:
        transactions - Transactions related to this payment.

      • setContextState

        public void setContextState​(com.broadleafcommerce.data.tracking.core.filtering.business.domain.ContextState contextState)
        Deprecated, for removal: This API element is subject to removal in a future version.
        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

      • equals

        public boolean equals​(Object o)
        Deprecated, for removal: This API element is subject to removal in a future version.
        Overrides:
        equals in class Object

      • canEqual

        protected boolean canEqual​(Object other)
        Deprecated, for removal: This API element is subject to removal in a future version.

      • hashCode

        public int hashCode()
        Deprecated, for removal: This API element is subject to removal in a future version.
        Overrides:
        hashCode in class Object

      • toString

        public String toString()
        Deprecated, for removal: This API element is subject to removal in a future version.
        Overrides:
        toString in class Object