com.paypal.sdk.models

Class LineItem

java.lang.Object

com.paypal.sdk.models.LineItem

public class LineItem
extends Object

This is a model class for LineItem type.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	LineItem.Builder Class to build instances of LineItem.

Constructor Summary

Constructors

Constructor and Description
LineItem() Default constructor.
LineItem(String name, String quantity, String description, String sku, String url, String imageUrl, UniversalProductCode upc, Money unitAmount, Money tax, String commodityCode, Money discountAmount, Money totalAmount, String unitOfMeasure) Initialization constructor.

Method Summary

Modifier and Type	Method and Description
String	getCommodityCode() Getter for CommodityCode.
String	getDescription() Getter for Description.
Money	getDiscountAmount() Getter for DiscountAmount.
String	getImageUrl() Getter for ImageUrl.
String	getName() Getter for Name.
String	getQuantity() Getter for Quantity.
String	getSku() Getter for Sku.
Money	getTax() Getter for Tax.
Money	getTotalAmount() Getter for TotalAmount.
Money	getUnitAmount() Getter for UnitAmount.
String	getUnitOfMeasure() Getter for UnitOfMeasure.
UniversalProductCode	getUpc() Getter for Upc.
String	getUrl() Getter for Url.
void	setCommodityCode(String commodityCode) Setter for CommodityCode.
void	setDescription(String description) Setter for Description.
void	setDiscountAmount(Money discountAmount) Setter for DiscountAmount.
void	setImageUrl(String imageUrl) Setter for ImageUrl.
void	setName(String name) Setter for Name.
void	setQuantity(String quantity) Setter for Quantity.
void	setSku(String sku) Setter for Sku.
void	setTax(Money tax) Setter for Tax.
void	setTotalAmount(Money totalAmount) Setter for TotalAmount.
void	setUnitAmount(Money unitAmount) Setter for UnitAmount.
void	setUnitOfMeasure(String unitOfMeasure) Setter for UnitOfMeasure.
void	setUpc(UniversalProductCode upc) Setter for Upc.
void	setUrl(String url) Setter for Url.
LineItem.Builder	toBuilder() Builds a new LineItem.Builder object.
String	toString() Converts this LineItem into string format.

Methods inherited from class java.lang.Object

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

Constructor Detail

LineItem

public LineItem()

Default constructor.

LineItem

public LineItem(String name,
                String quantity,
                String description,
                String sku,
                String url,
                String imageUrl,
                UniversalProductCode upc,
                Money unitAmount,
                Money tax,
                String commodityCode,
                Money discountAmount,
                Money totalAmount,
                String unitOfMeasure)

Initialization constructor.

Parameters:

name - String value for name.

quantity - String value for quantity.

description - String value for description.

sku - String value for sku.

url - String value for url.

imageUrl - String value for imageUrl.

upc - UniversalProductCode value for upc.

unitAmount - Money value for unitAmount.

tax - Money value for tax.

commodityCode - String value for commodityCode.

discountAmount - Money value for discountAmount.

totalAmount - Money value for totalAmount.

unitOfMeasure - String value for unitOfMeasure.

Method Detail

getName

public String getName()

Getter for Name. The item name or title.

Returns:

Returns the String

setName

public void setName(String name)

Setter for Name. The item name or title.

Parameters:

name - Value for String

getQuantity

public String getQuantity()

Getter for Quantity. The item quantity. Must be a whole number.

Returns:

Returns the String

setQuantity

public void setQuantity(String quantity)

Setter for Quantity. The item quantity. Must be a whole number.

Parameters:

quantity - Value for String

getDescription

public String getDescription()

Getter for Description. The detailed item description.

Returns:

Returns the String

setDescription

public void setDescription(String description)

Setter for Description. The detailed item description.

Parameters:

description - Value for String

getSku

public String getSku()

Getter for Sku. The stock keeping unit (SKU) for the item.

Returns:

Returns the String

setSku

public void setSku(String sku)

Setter for Sku. The stock keeping unit (SKU) for the item.

Parameters:

sku - Value for String

getUrl

public String getUrl()

Getter for Url. The URL to the item being purchased. Visible to buyer and used in buyer experiences.

Returns:

Returns the String

setUrl

public void setUrl(String url)

Setter for Url. The URL to the item being purchased. Visible to buyer and used in buyer experiences.

Parameters:

url - Value for String

getImageUrl

public String getImageUrl()

Getter for ImageUrl. The URL of the item's image. File type and size restrictions apply. An image that violates these restrictions will not be honored.

Returns:

Returns the String

setImageUrl

public void setImageUrl(String imageUrl)

Setter for ImageUrl. The URL of the item's image. File type and size restrictions apply. An image that violates these restrictions will not be honored.

Parameters:

imageUrl - Value for String

getUpc

public UniversalProductCode getUpc()

Getter for Upc. The Universal Product Code of the item.

Returns:

Returns the UniversalProductCode

setUpc

public void setUpc(UniversalProductCode upc)

Setter for Upc. The Universal Product Code of the item.

Parameters:

upc - Value for UniversalProductCode

getUnitAmount

public Money getUnitAmount()

Getter for UnitAmount. The currency and amount for a financial transaction, such as a balance or payment due.

Returns:

Returns the Money

setUnitAmount

public void setUnitAmount(Money unitAmount)

Setter for UnitAmount. The currency and amount for a financial transaction, such as a balance or payment due.

Parameters:

unitAmount - Value for Money

getTax

public Money getTax()

Getter for Tax. The currency and amount for a financial transaction, such as a balance or payment due.

Returns:

Returns the Money

setTax

public void setTax(Money tax)

Setter for Tax. The currency and amount for a financial transaction, such as a balance or payment due.

Parameters:

tax - Value for Money

getCommodityCode

public String getCommodityCode()

Getter for CommodityCode. Code used to classify items purchased and track the total amount spent across various categories of products and services. Different corporate purchasing organizations may use different standards, but the United Nations Standard Products and Services Code (UNSPSC) is frequently used.

Returns:

Returns the String

setCommodityCode

public void setCommodityCode(String commodityCode)

Setter for CommodityCode. Code used to classify items purchased and track the total amount spent across various categories of products and services. Different corporate purchasing organizations may use different standards, but the United Nations Standard Products and Services Code (UNSPSC) is frequently used.

Parameters:

commodityCode - Value for String

getDiscountAmount

public Money getDiscountAmount()

Getter for DiscountAmount. The currency and amount for a financial transaction, such as a balance or payment due.

Returns:

Returns the Money

setDiscountAmount

public void setDiscountAmount(Money discountAmount)

Setter for DiscountAmount. The currency and amount for a financial transaction, such as a balance or payment due.

Parameters:

discountAmount - Value for Money

getTotalAmount

public Money getTotalAmount()

Getter for TotalAmount. The currency and amount for a financial transaction, such as a balance or payment due.

Returns:

Returns the Money

setTotalAmount

public void setTotalAmount(Money totalAmount)

Setter for TotalAmount. The currency and amount for a financial transaction, such as a balance or payment due.

Parameters:

totalAmount - Value for Money

getUnitOfMeasure

public String getUnitOfMeasure()

Getter for UnitOfMeasure. Unit of measure is a standard used to express the magnitude of a quantity in international trade. Most commonly used (but not limited to) examples are: Acre (ACR), Ampere (AMP), Centigram (CGM), Centimetre (CMT), Cubic inch (INQ), Cubic metre (MTQ), Fluid ounce (OZA), Foot (FOT), Hour (HUR), Item (ITM), Kilogram (KGM), Kilometre (KMT), Kilowatt (KWT), Liquid gallon (GLL), Liter (LTR), Pounds (LBS), Square foot (FTK).

Returns:

Returns the String

setUnitOfMeasure

public void setUnitOfMeasure(String unitOfMeasure)

Setter for UnitOfMeasure. Unit of measure is a standard used to express the magnitude of a quantity in international trade. Most commonly used (but not limited to) examples are: Acre (ACR), Ampere (AMP), Centigram (CGM), Centimetre (CMT), Cubic inch (INQ), Cubic metre (MTQ), Fluid ounce (OZA), Foot (FOT), Hour (HUR), Item (ITM), Kilogram (KGM), Kilometre (KMT), Kilowatt (KWT), Liquid gallon (GLL), Liter (LTR), Pounds (LBS), Square foot (FTK).

Parameters:

unitOfMeasure - Value for String

toString

public String toString()

Converts this LineItem into string format.

Overrides:

toString in class Object

Returns:

String representation of this class

toBuilder

public LineItem.Builder toBuilder()

Builds a new LineItem.Builder object. Creates the instance with the state of the current model.

Returns:

a new LineItem.Builder object