Class PaymentRef
java.lang.Object
com.broadleafcommerce.cartoperation.service.messaging.finalizecart.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
The gateway used to process this payment.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.getType()
The type of this payment like Credit Card or Gift Card.int
hashCode()
void
setGatewayType
(String gatewayType) The gateway used to process this payment.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.void
The type of this payment like Credit Card or Gift Card.toString()
-
Constructor Details
-
PaymentRef
public PaymentRef()
-
-
Method Details
-
getId
The payment's id.- Returns:
- The payment's id.
-
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
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
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
-
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.
-
setType
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
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
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
-
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
-