Class PaymentRef
java.lang.Object
com.broadleafcommerce.paymenttransaction.domain.PaymentRef
- All Implemented Interfaces:
Serializable
A reference to a payment.
- Author:
- Chris Kittrell (ckittrell)
- See Also:
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionprotected boolean
boolean
fromPayment
(Payment payment) Builds aPaymentRef
based on the providedPayment
getId()
The payment's id.getName()
The payment's name.The id of the entity that owns this payment.Describes the owner of the payment.The id of the owning user that owns this payment.Describes the owning user type of the payment.int
hashCode()
void
The payment's id.void
The payment's name.void
setOwnerId
(String ownerId) The id of the entity that owns this payment.void
setOwnerType
(String ownerType) Describes the owner of the payment.void
setOwningUserId
(String owningUserId) The id of the owning user that owns this payment.void
setOwningUserType
(String owningUserType) Describes the owning user type of the payment.toString()
-
Constructor Details
-
PaymentRef
public PaymentRef()
-
-
Method Details
-
fromPayment
Builds aPaymentRef
based on the providedPayment
- Parameters:
payment
- the Payment used to build the PaymentRef- Returns:
- a PaymentRef based on the provided Payment
-
getId
The payment's id.- Returns:
- The payment's id.
-
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
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
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
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
The payment's name.- Returns:
- The payment's name.
-
setId
The payment's id.- Parameters:
id
- The payment's id.
-
setOwnerType
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
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
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
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
The payment's name.- Parameters:
username
- The payment's name.
-
equals
-
canEqual
-
hashCode
public int hashCode() -
toString
-