Package org.broadleafcommerce.common.payment.dto

Class LineItemDTO

java.lang.Object

org.broadleafcommerce.common.payment.dto.LineItemDTO

public class LineItemDTO
extends Object

Author:

Elbert Bautista (elbertbautista)

Many Hosted solutions, (e.g. PayPal Express/Sagepay Form) allow you to pass in the contents of your cart to be displayed on their hosted pages.

The following DTO represent the usual parameters that you may wish to pass:

name: a Name for this Line Item description: a Description for this Line Item category: a Category for this Line Item (PayPal Express uses this to differentiate between Digital vs Physical) quantity: the Quantity for this Line Item amount: the unit cost of the item without tax tax: the tax applied to this unit item itemTotal: the cost of the unit item with tax total: the total cost of this line item (Quanity x Cost Including Tax)

Field Summary

Fields

Modifier and Type	Field	Description
protected Map<String,Object>	additionalFields
protected String	amount
protected String	category
protected String	description
protected String	itemTotal
protected String	name
protected PaymentRequestDTO	parent
protected String	quantity
protected String	shortDescription
protected String	systemId
protected String	tax
protected String	total

Constructor Summary

Constructors

Constructor	Description
LineItemDTO(PaymentRequestDTO parent)

Method Summary

Modifier and Type	Method	Description
LineItemDTO	additionalField(String key, Object value)
LineItemDTO	amount(String amount)
LineItemDTO	category(String category)
LineItemDTO	description(String description)
PaymentRequestDTO	done()
Map<String,Object>	getAdditionalFields()
String	getAmount()
String	getCategory()
String	getDescription()
String	getItemTotal()
String	getName()
String	getQuantity()
String	getShortDescription()
String	getSystemId()
String	getTax()
String	getTotal()
LineItemDTO	itemTotal(String itemTotal)
LineItemDTO	name(String name)
LineItemDTO	quantity(String quantity)
LineItemDTO	shortDescription(String shortDescription)
LineItemDTO	systemId(String systemId)
LineItemDTO	tax(String tax)
LineItemDTO	total(String total)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

parent

protected PaymentRequestDTO parent

additionalFields

protected Map<String,Object> additionalFields

name

protected String name

description

protected String description

shortDescription

protected String shortDescription

systemId

protected String systemId

category

protected String category

quantity

protected String quantity

amount

protected String amount

tax

protected String tax

itemTotal

protected String itemTotal

total

protected String total

Constructor Details

LineItemDTO

public LineItemDTO(PaymentRequestDTO parent)

Method Details

done

public PaymentRequestDTO done()

additionalField

public LineItemDTO additionalField(String key,
 Object value)

name

public LineItemDTO name(String name)

description

public LineItemDTO description(String description)

shortDescription

public LineItemDTO shortDescription(String shortDescription)

systemId

public LineItemDTO systemId(String systemId)

category

public LineItemDTO category(String category)

quantity

public LineItemDTO quantity(String quantity)

amount

public LineItemDTO amount(String amount)

tax

public LineItemDTO tax(String tax)

itemTotal

public LineItemDTO itemTotal(String itemTotal)

total

public LineItemDTO total(String total)

getAdditionalFields

public Map<String,Object> getAdditionalFields()

getName

public String getName()

getDescription

public String getDescription()

getShortDescription

public String getShortDescription()

getSystemId

public String getSystemId()

getCategory

public String getCategory()

getQuantity

public String getQuantity()

getAmount

public String getAmount()

getTax

public String getTax()

getItemTotal

public String getItemTotal()

getTotal

public String getTotal()