Package com.commercetools.api.models.cart

Class CustomLineItemImpl

java.lang.Object

com.commercetools.api.models.cart.CustomLineItemImpl

All Implemented Interfaces:

CustomLineItem, Customizable<CustomLineItem>, io.vrap.rmf.base.client.ModelBase

public class CustomLineItemImpl
extends Object
implements CustomLineItem, io.vrap.rmf.base.client.ModelBase

A generic item that can be added to the Cart but is not bound to a Product that can be used for discounts (negative money), vouchers, complex cart rules, additional services, or fees. You control the lifecycle of this item.

Nested Class Summary

Nested classes/interfaces inherited from interface io.vrap.rmf.base.client.ModelBase

io.vrap.rmf.base.client.ModelBase.FilteredRecursiveToStringStyle

Constructor Summary

Constructors

Constructor	Description
CustomLineItemImpl()	create empty instance

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
CustomFields	getCustom()	Custom Fields of the Custom Line Item.
List<DiscountedLineItemPriceForQuantity>	getDiscountedPricePerQuantity()	Discounted price of a single quantity of the Custom Line Item.
String	getId()	Unique identifier of the Custom Line Item.
TypedMoney	getMoney()	Money value of the Custom Line Item.
LocalizedString	getName()	Name of the Custom Line Item.
List<MethodTaxRate>	getPerMethodTaxRate()	Tax Rate per Shipping Method for a Cart with Multiple ShippingMode.
CustomLineItemPriceMode	getPriceMode()	Indicates whether Cart Discounts with a matching CartDiscountCustomLineItemsTarget are applied to the Custom Line Item.
Long	getQuantity()	Number of Custom Line Items in the Cart.
ItemShippingDetails	getShippingDetails()	Container for Custom Line Item-specific addresses.
String	getSlug()	User-defined identifier used in a deep-link URL for the Custom Line Item.
List<ItemState>	getState()	State of the Custom Line Item in the Cart.
TaxCategoryReference	getTaxCategory()	Used to select a Tax Rate when a Cart has the Platform TaxMode.
TaxedItemPrice	getTaxedPrice()	Automatically set after the taxRate is set.
TaxRate	getTaxRate()	For a Cart with Platform TaxMode, the taxRate of Custom Line Items is set automatically once a shipping address is set.
CentPrecisionMoney	getTotalPrice()	Total price of the Custom Line Item (money multiplied by quantity).
int	hashCode()
void	setCustom(CustomFields custom)	Custom Fields of the Custom Line Item.
void	setDiscountedPricePerQuantity(DiscountedLineItemPriceForQuantity... discountedPricePerQuantity)	Discounted price of a single quantity of the Custom Line Item.
void	setDiscountedPricePerQuantity(List<DiscountedLineItemPriceForQuantity> discountedPricePerQuantity)	Discounted price of a single quantity of the Custom Line Item.
void	setId(String id)	Unique identifier of the Custom Line Item.
void	setMoney(TypedMoney money)	Money value of the Custom Line Item.
void	setName(LocalizedString name)	Name of the Custom Line Item.
void	setPerMethodTaxRate(MethodTaxRate... perMethodTaxRate)	Tax Rate per Shipping Method for a Cart with Multiple ShippingMode.
void	setPerMethodTaxRate(List<MethodTaxRate> perMethodTaxRate)	Tax Rate per Shipping Method for a Cart with Multiple ShippingMode.
void	setPriceMode(CustomLineItemPriceMode priceMode)	Indicates whether Cart Discounts with a matching CartDiscountCustomLineItemsTarget are applied to the Custom Line Item.
void	setQuantity(Long quantity)	Number of Custom Line Items in the Cart.
void	setShippingDetails(ItemShippingDetails shippingDetails)	Container for Custom Line Item-specific addresses.
void	setSlug(String slug)	User-defined identifier used in a deep-link URL for the Custom Line Item.
void	setState(ItemState... state)	State of the Custom Line Item in the Cart.
void	setState(List<ItemState> state)	State of the Custom Line Item in the Cart.
void	setTaxCategory(TaxCategoryReference taxCategory)	Used to select a Tax Rate when a Cart has the Platform TaxMode.
void	setTaxedPrice(TaxedItemPrice taxedPrice)	Automatically set after the taxRate is set.
void	setTaxRate(TaxRate taxRate)	For a Cart with Platform TaxMode, the taxRate of Custom Line Items is set automatically once a shipping address is set.
void	setTotalPrice(CentPrecisionMoney totalPrice)	Total price of the Custom Line Item (money multiplied by quantity).

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.commercetools.api.models.Customizable

unwrapCustomizable

Methods inherited from interface com.commercetools.api.models.cart.CustomLineItem

withCustomLineItem

Methods inherited from interface io.vrap.rmf.base.client.ModelBase

reflectionString, reflectionString

Constructor Details

CustomLineItemImpl

public CustomLineItemImpl()

create empty instance

Method Details

getId

public String getId()

Unique identifier of the Custom Line Item.

Specified by:

getId in interface CustomLineItem

Returns:

id

getName

public LocalizedString getName()

Name of the Custom Line Item.

Specified by:

getName in interface CustomLineItem

Returns:

name

getMoney

public TypedMoney getMoney()

Money value of the Custom Line Item.

Specified by:

getMoney in interface CustomLineItem

Returns:

money

getTaxedPrice

public TaxedItemPrice getTaxedPrice()

Automatically set after the taxRate is set.

Specified by:

getTaxedPrice in interface CustomLineItem

Returns:

taxedPrice

getTotalPrice

public CentPrecisionMoney getTotalPrice()

Total price of the Custom Line Item (money multiplied by quantity). If the Custom Line Item is discounted, the total price is discountedPricePerQuantity multiplied by quantity.

Includes taxes if the TaxRate includedInPrice is true.

Specified by:

getTotalPrice in interface CustomLineItem

Returns:

totalPrice

getSlug

public String getSlug()

User-defined identifier used in a deep-link URL for the Custom Line Item. It matches the pattern [a-zA-Z0-9_-]{2,256}.

Specified by:

getSlug in interface CustomLineItem

Returns:

slug

getQuantity

public Long getQuantity()

Number of Custom Line Items in the Cart.

Specified by:

getQuantity in interface CustomLineItem

Returns:

quantity

getState

public List<ItemState> getState()

State of the Custom Line Item in the Cart.

Specified by:

getState in interface CustomLineItem

Returns:

state

getTaxCategory

public TaxCategoryReference getTaxCategory()

Used to select a Tax Rate when a Cart has the Platform TaxMode.

Specified by:

getTaxCategory in interface CustomLineItem

Returns:

taxCategory

getTaxRate

public TaxRate getTaxRate()

• For a Cart with Platform TaxMode, the taxRate of Custom Line Items is set automatically once a shipping address is set. The rate is based on the TaxCategory that applies for the shipping address.
• For a Cart with External TaxMode, the taxRate of Custom Line Items can be set using ExternalTaxRateDraft.

Specified by:

getTaxRate in interface CustomLineItem

Returns:

taxRate

getPerMethodTaxRate

public List<MethodTaxRate> getPerMethodTaxRate()

Tax Rate per Shipping Method for a Cart with Multiple ShippingMode. For a Cart with Platform TaxMode it is automatically set after the Shipping Method is added. For a Cart with External TaxMode, the Tax Rate must be set with ExternalTaxRateDraft.

Specified by:

getPerMethodTaxRate in interface CustomLineItem

Returns:

perMethodTaxRate

getDiscountedPricePerQuantity

public List<DiscountedLineItemPriceForQuantity> getDiscountedPricePerQuantity()

Discounted price of a single quantity of the Custom Line Item.

Specified by:

getDiscountedPricePerQuantity in interface CustomLineItem

Returns:

discountedPricePerQuantity

getCustom

public CustomFields getCustom()

Custom Fields of the Custom Line Item.

Specified by:

getCustom in interface Customizable<CustomLineItem>

Specified by:

getCustom in interface CustomLineItem

Returns:

custom

getShippingDetails

public ItemShippingDetails getShippingDetails()

Container for Custom Line Item-specific addresses.

Specified by:

getShippingDetails in interface CustomLineItem

Returns:

shippingDetails

getPriceMode

public CustomLineItemPriceMode getPriceMode()

Indicates whether Cart Discounts with a matching CartDiscountCustomLineItemsTarget are applied to the Custom Line Item.

Specified by:

getPriceMode in interface CustomLineItem

Returns:

priceMode

setId

public void setId(String id)

Description copied from interface: CustomLineItem

Unique identifier of the Custom Line Item.

Specified by:

setId in interface CustomLineItem

Parameters:

id - value to be set

setName

public void setName(LocalizedString name)

Description copied from interface: CustomLineItem

Name of the Custom Line Item.

Specified by:

setName in interface CustomLineItem

Parameters:

name - value to be set

setMoney

public void setMoney(TypedMoney money)

Description copied from interface: CustomLineItem

Money value of the Custom Line Item.

Specified by:

setMoney in interface CustomLineItem

Parameters:

money - value to be set

setTaxedPrice

public void setTaxedPrice(TaxedItemPrice taxedPrice)

Description copied from interface: CustomLineItem

Automatically set after the taxRate is set.

Specified by:

setTaxedPrice in interface CustomLineItem

Parameters:

taxedPrice - value to be set

setTotalPrice

public void setTotalPrice(CentPrecisionMoney totalPrice)

Description copied from interface: CustomLineItem

Total price of the Custom Line Item (money multiplied by quantity). If the Custom Line Item is discounted, the total price is discountedPricePerQuantity multiplied by quantity.

Includes taxes if the TaxRate includedInPrice is true.

Specified by:

setTotalPrice in interface CustomLineItem

Parameters:

totalPrice - value to be set

setSlug

public void setSlug(String slug)

Description copied from interface: CustomLineItem

User-defined identifier used in a deep-link URL for the Custom Line Item. It matches the pattern [a-zA-Z0-9_-]{2,256}.

Specified by:

setSlug in interface CustomLineItem

Parameters:

slug - value to be set

setQuantity

public void setQuantity(Long quantity)

Description copied from interface: CustomLineItem

Number of Custom Line Items in the Cart.

Specified by:

setQuantity in interface CustomLineItem

Parameters:

quantity - value to be set

setState

public void setState(ItemState... state)

Description copied from interface: CustomLineItem

State of the Custom Line Item in the Cart.

Specified by:

setState in interface CustomLineItem

Parameters:

state - values to be set

setState

public void setState(List<ItemState> state)

Description copied from interface: CustomLineItem

State of the Custom Line Item in the Cart.

Specified by:

setState in interface CustomLineItem

Parameters:

state - values to be set

setTaxCategory

public void setTaxCategory(TaxCategoryReference taxCategory)

Description copied from interface: CustomLineItem

Used to select a Tax Rate when a Cart has the Platform TaxMode.

Specified by:

setTaxCategory in interface CustomLineItem

Parameters:

taxCategory - value to be set

setTaxRate

public void setTaxRate(TaxRate taxRate)

Description copied from interface: CustomLineItem

• For a Cart with Platform TaxMode, the taxRate of Custom Line Items is set automatically once a shipping address is set. The rate is based on the TaxCategory that applies for the shipping address.
• For a Cart with External TaxMode, the taxRate of Custom Line Items can be set using ExternalTaxRateDraft.

Specified by:

setTaxRate in interface CustomLineItem

Parameters:

taxRate - value to be set

setPerMethodTaxRate

public void setPerMethodTaxRate(MethodTaxRate... perMethodTaxRate)

Description copied from interface: CustomLineItem

Tax Rate per Shipping Method for a Cart with Multiple ShippingMode. For a Cart with Platform TaxMode it is automatically set after the Shipping Method is added. For a Cart with External TaxMode, the Tax Rate must be set with ExternalTaxRateDraft.

Specified by:

setPerMethodTaxRate in interface CustomLineItem

Parameters:

perMethodTaxRate - values to be set

setPerMethodTaxRate

public void setPerMethodTaxRate(List<MethodTaxRate> perMethodTaxRate)

Description copied from interface: CustomLineItem

Tax Rate per Shipping Method for a Cart with Multiple ShippingMode. For a Cart with Platform TaxMode it is automatically set after the Shipping Method is added. For a Cart with External TaxMode, the Tax Rate must be set with ExternalTaxRateDraft.

Specified by:

setPerMethodTaxRate in interface CustomLineItem

Parameters:

perMethodTaxRate - values to be set

setDiscountedPricePerQuantity

public void setDiscountedPricePerQuantity(DiscountedLineItemPriceForQuantity... discountedPricePerQuantity)

Description copied from interface: CustomLineItem

Discounted price of a single quantity of the Custom Line Item.

Specified by:

setDiscountedPricePerQuantity in interface CustomLineItem

Parameters:

discountedPricePerQuantity - values to be set

setDiscountedPricePerQuantity

public void setDiscountedPricePerQuantity(List<DiscountedLineItemPriceForQuantity> discountedPricePerQuantity)

Description copied from interface: CustomLineItem

Discounted price of a single quantity of the Custom Line Item.

Specified by:

setDiscountedPricePerQuantity in interface CustomLineItem

Parameters:

discountedPricePerQuantity - values to be set

setCustom

public void setCustom(CustomFields custom)

Description copied from interface: CustomLineItem

Custom Fields of the Custom Line Item.

Specified by:

setCustom in interface Customizable<CustomLineItem>

Specified by:

setCustom in interface CustomLineItem

Parameters:

custom - value to be set

setShippingDetails

public void setShippingDetails(ItemShippingDetails shippingDetails)

Description copied from interface: CustomLineItem

Container for Custom Line Item-specific addresses.

Specified by:

setShippingDetails in interface CustomLineItem

Parameters:

shippingDetails - value to be set

setPriceMode

public void setPriceMode(CustomLineItemPriceMode priceMode)

Description copied from interface: CustomLineItem

Indicates whether Cart Discounts with a matching CartDiscountCustomLineItemsTarget are applied to the Custom Line Item.

Specified by:

setPriceMode in interface CustomLineItem

Parameters:

priceMode - value to be set

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object