Package com.broadleafcommerce.paymenttransaction.domain

Class PaymentRef

java.lang.Object
com.broadleafcommerce.paymenttransaction.domain.PaymentRef
All Implemented Interfaces:
Serializable
public class PaymentRef extends Object implements Serializable
A reference to a payment.
Author:
Chris Kittrell (ckittrell)
See Also:

  • Constructor Details

    • PaymentRef

      public PaymentRef()

  • Method Details

    • fromPayment

      public PaymentRef fromPayment(Payment payment)
      Builds a PaymentRef based on the provided Payment
      Parameters:
      payment - the Payment used to build the PaymentRef
      Returns:
      a PaymentRef based on the provided Payment

    • getId

      public String getId()
      The payment's id.
      Returns:
      The payment's id.

    • getType

      public String getType()
      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()
      The gateway used to process this payment. Only a SINGLE payment gateway can be used for a payment.
      Returns:
      The gateway used to process this payment.

    • getOwnerType

      public String getOwnerType()
      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()
      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.

    • getOwningUserType

      public String getOwningUserType()
      Describes the owning user type of the payment. For example, the payment could belong to a customer or an account, therefore this value might be BLC_CUSTOMER or BLC_ACCOUNT.
      Returns:
      The type describing the owning user of the payment
      See Also:

    • getOwningUserId

      public String getOwningUserId()
      The id of the owning user that owns this payment. For example, this may be a customer id, or an account id.
      Returns:
      The id of the owning user that owns this payment.

    • getName

      public String getName()
      The payment's name.
      Returns:
      The payment's name.

    • setId

      public void setId(String id)
      The payment's id.
      Parameters:
      id - The payment's id.

    • setType

      public void setType(String type)
      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)
      The gateway used to process this payment. Only a SINGLE payment gateway can be used for a payment.
      Parameters:
      gatewayType - The gateway used to process this payment.

    • setOwnerType

      public void setOwnerType(String ownerType)
      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)
      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.

    • setOwningUserType

      public void setOwningUserType(String owningUserType)
      Describes the owning user type of the payment. For example, the payment could belong to a customer or an account, therefore this value might be BLC_CUSTOMER or BLC_ACCOUNT.
      Parameters:
      owningUserType - The type describing the owning user of the payment
      See Also:

    • setOwningUserId

      public void setOwningUserId(String owningUserId)
      The id of the owning user that owns this payment. For example, this may be a customer id, or an account id.
      Parameters:
      owningUserId - The id of the owning user that owns this payment.

    • setName

      public void setName(String name)
      The payment's name.
      Parameters:
      username - The payment's name.

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object

    • canEqual

      protected boolean canEqual(Object other)

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • toString

      public String toString()
      Overrides:
      toString in class Object