Class TransactionLineItem
java.lang.Object
com.broadleafcommerce.paymenttransaction.web.endpoint.domain.TransactionLineItem
- All Implemented Interfaces:
Serializable
The payload used to describe a line item related to a given
TransactionExecutionRequest
- Author:
- Chris Kittrell (ckittrell)
- See Also:
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionprotected boolean
boolean
Miscellaneous attributes that can be added to this payload in order to provide more information.javax.money.CurrencyUnit
The currency gathered from thegetItemTotal()
The description of the line item.getId()
The id of the line item, typically the cart item id.The url of the line item's image.javax.money.MonetaryAmount
The line item total cost, including merchandise cost, fulfillment cost, & tax assigned to the item.getName()
The name of the line item, typically the cart item name.int
The quantity of the line item.getSku()
The sku of the line item.int
hashCode()
void
setAdditionalAttributes
(Map<String, Object> additionalAttributes) Miscellaneous attributes that can be added to this payload in order to provide more information.void
setDescription
(String description) The description of the line item.void
The id of the line item, typically the cart item id.void
setImageUrl
(String imageUrl) The url of the line item's image.void
setItemTotal
(javax.money.MonetaryAmount itemTotal) The line item total cost, including merchandise cost, fulfillment cost, & tax assigned to the item.void
The name of the line item, typically the cart item name.void
setQuantity
(int quantity) The quantity of the line item.void
The sku of the line item.toString()
-
Constructor Details
-
TransactionLineItem
public TransactionLineItem()
-
-
Method Details
-
getCurrency
@Nullable public javax.money.CurrencyUnit getCurrency()The currency gathered from thegetItemTotal()
- Returns:
- The currency gathered from the item total
-
getId
The id of the line item, typically the cart item id.- Returns:
- The id of the line item, typically the cart item id.
-
getName
The name of the line item, typically the cart item name.- Returns:
- The name of the line item, typically the cart item name.
-
getDescription
The description of the line item.- Returns:
- The description of the line item.
-
getSku
The sku of the line item.- Returns:
- The sku of the line item.
-
getItemTotal
public javax.money.MonetaryAmount getItemTotal()The line item total cost, including merchandise cost, fulfillment cost, & tax assigned to the item.- Returns:
- The line item total cost, including merchandise cost, fulfillment cost, & tax assigned to the item.
-
getQuantity
public int getQuantity()The quantity of the line item.- Returns:
- The quantity of the line item.
-
getImageUrl
The url of the line item's image.- Returns:
- The url of the line item's image.
-
getAdditionalAttributes
Miscellaneous attributes that can be added to this payload in order to provide more information. Note, it is recommended to not add any sensitive information in these attributes.- Returns:
- Miscellaneous attributes that can be added to this payload.
-
setId
The id of the line item, typically the cart item id.- Parameters:
id
- The id of the line item, typically the cart item id.
-
setName
The name of the line item, typically the cart item name.- Parameters:
name
- The name of the line item, typically the cart item name.
-
setDescription
The description of the line item.- Parameters:
description
- The description of the line item.
-
setSku
The sku of the line item.- Parameters:
sku
- The sku of the line item.
-
setItemTotal
public void setItemTotal(javax.money.MonetaryAmount itemTotal) The line item total cost, including merchandise cost, fulfillment cost, & tax assigned to the item.- Parameters:
itemTotal
- The line item total cost, including merchandise cost, fulfillment cost, & tax assigned to the item.
-
setQuantity
public void setQuantity(int quantity) The quantity of the line item.- Parameters:
quantity
- The quantity of the line item.
-
setImageUrl
The url of the line item's image.- Parameters:
imageUrl
- The url of the line item's image.
-
setAdditionalAttributes
Miscellaneous attributes that can be added to this payload in order to provide more information. Note, it is recommended to not add any sensitive information in these attributes.- Parameters:
additionalAttributes
- Miscellaneous attributes that can be added to this payload.
-
equals
-
canEqual
-
hashCode
public int hashCode() -
toString
-