Package com.commercetools.api.models.cart

Class CartAddCustomLineItemActionImpl

java.lang.Object

com.commercetools.api.models.cart.CartAddCustomLineItemActionImpl

All Implemented Interfaces:

CartAddCustomLineItemAction, CartUpdateAction, CustomizableDraft<CartAddCustomLineItemAction>, ResourceUpdateAction<CartUpdateAction>, io.vrap.rmf.base.client.ModelBase

public class CartAddCustomLineItemActionImpl
extends Object
implements CartAddCustomLineItemAction, io.vrap.rmf.base.client.ModelBase

If the Cart already contains a CustomLineItem with the same slug, name, money, taxCategory, state, and Custom Fields, then only the quantity of the existing Custom Line Item is increased. If CustomLineItem shippingDetails are set, they are merged with the targets that already exist on the ItemShippingDetails of the Custom Line Item. In case of overlapping address keys the ItemShippingTarget quantity is summed up.

If the Cart already contains a Custom Line Item with the same slug that is otherwise not identical, an InvalidOperation error is returned.

If the Tax Rate is not set, a MissingTaxRateForCountry error is returned.

Nested Class Summary

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

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

Field Summary

Fields inherited from interface com.commercetools.api.models.cart.CartAddCustomLineItemAction

ADD_CUSTOM_LINE_ITEM

Constructor Summary

Constructors

Constructor	Description
CartAddCustomLineItemActionImpl()	create empty instance

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
String	getAction()
CustomFieldsDraft	getCustom()	Custom Fields for the Custom Line Item.
ExternalTaxRateDraft	getExternalTaxRate()	An external Tax Rate can be set if the Cart has External TaxMode.
String	getKey()	User-defined unique identifier of the Custom Line Item.
Money	getMoney()	Money value of the Custom Line Item.
LocalizedString	getName()	Name of the Custom Line Item.
CustomLineItemPriceMode	getPriceMode()	If Standard, Cart Discounts with a matching CartDiscountCustomLineItemsTarget are applied to the Custom Line Item. If External, Cart Discounts are not considered on the Custom Line Item.
Long	getQuantity()	Number of Custom Line Items to add to the Cart.
ItemShippingDetailsDraft	getShippingDetails()	Container for Custom Line Item-specific addresses.
String	getSlug()	User-defined identifier used in a deep-link URL for the Custom Line Item.
TaxCategoryResourceIdentifier	getTaxCategory()	Used to select a Tax Rate when a Cart has the Platform TaxMode.
int	hashCode()
void	setCustom(CustomFieldsDraft custom)	Custom Fields for the Custom Line Item.
void	setExternalTaxRate(ExternalTaxRateDraft externalTaxRate)	An external Tax Rate can be set if the Cart has External TaxMode.
void	setKey(String key)	User-defined unique identifier of the Custom Line Item.
void	setMoney(Money money)	Money value of the Custom Line Item.
void	setName(LocalizedString name)	Name of the Custom Line Item.
void	setPriceMode(CustomLineItemPriceMode priceMode)	If Standard, Cart Discounts with a matching CartDiscountCustomLineItemsTarget are applied to the Custom Line Item. If External, Cart Discounts are not considered on the Custom Line Item.
void	setQuantity(Long quantity)	Number of Custom Line Items to add to the Cart.
void	setShippingDetails(ItemShippingDetailsDraft 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	setTaxCategory(TaxCategoryResourceIdentifier taxCategory)	Used to select a Tax Rate when a Cart has the Platform TaxMode.

Methods inherited from class java.lang.Object

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

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

withCartAddCustomLineItemAction

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

withCartUpdateAction

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

unwrapCustomizableDraft

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

reflectionString, reflectionString

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

get

Constructor Details

CartAddCustomLineItemActionImpl

public CartAddCustomLineItemActionImpl()

create empty instance

Method Details

getAction

public String getAction()

Specified by:

getAction in interface CartUpdateAction

Specified by:

getAction in interface ResourceUpdateAction<CartUpdateAction>

Returns:

action

getMoney

public Money getMoney()

Money value of the Custom Line Item. The value can be negative.

Specified by:

getMoney in interface CartAddCustomLineItemAction

Returns:

money

getName

public LocalizedString getName()

Name of the Custom Line Item.

Specified by:

getName in interface CartAddCustomLineItemAction

Returns:

name

getKey

public String getKey()

User-defined unique identifier of the Custom Line Item.

Specified by:

getKey in interface CartAddCustomLineItemAction

Returns:

key

getQuantity

public Long getQuantity()

Number of Custom Line Items to add to the Cart.

Specified by:

getQuantity in interface CartAddCustomLineItemAction

Returns:

quantity

getSlug

public String getSlug()

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

Specified by:

getSlug in interface CartAddCustomLineItemAction

Returns:

slug

getTaxCategory

public TaxCategoryResourceIdentifier getTaxCategory()

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

If TaxMode is Platform, this field must not be empty.

Specified by:

getTaxCategory in interface CartAddCustomLineItemAction

Returns:

taxCategory

getExternalTaxRate

public ExternalTaxRateDraft getExternalTaxRate()

An external Tax Rate can be set if the Cart has External TaxMode.

Specified by:

getExternalTaxRate in interface CartAddCustomLineItemAction

Returns:

externalTaxRate

getShippingDetails

public ItemShippingDetailsDraft getShippingDetails()

Container for Custom Line Item-specific addresses.

Specified by:

getShippingDetails in interface CartAddCustomLineItemAction

Returns:

shippingDetails

getCustom

public CustomFieldsDraft getCustom()

Custom Fields for the Custom Line Item.

Specified by:

getCustom in interface CartAddCustomLineItemAction

Specified by:

getCustom in interface CustomizableDraft<CartAddCustomLineItemAction>

Returns:

custom

getPriceMode

public CustomLineItemPriceMode getPriceMode()

• If Standard, Cart Discounts with a matching CartDiscountCustomLineItemsTarget are applied to the Custom Line Item.
• If External, Cart Discounts are not considered on the Custom Line Item.

Specified by:

getPriceMode in interface CartAddCustomLineItemAction

Returns:

priceMode

setMoney

public void setMoney(Money money)

Description copied from interface: CartAddCustomLineItemAction

Money value of the Custom Line Item. The value can be negative.

Specified by:

setMoney in interface CartAddCustomLineItemAction

Parameters:

money - value to be set

setName

public void setName(LocalizedString name)

Description copied from interface: CartAddCustomLineItemAction

Name of the Custom Line Item.

Specified by:

setName in interface CartAddCustomLineItemAction

Parameters:

name - value to be set

setKey

public void setKey(String key)

Description copied from interface: CartAddCustomLineItemAction

User-defined unique identifier of the Custom Line Item.

Specified by:

setKey in interface CartAddCustomLineItemAction

Parameters:

key - value to be set

setQuantity

public void setQuantity(Long quantity)

Description copied from interface: CartAddCustomLineItemAction

Number of Custom Line Items to add to the Cart.

Specified by:

setQuantity in interface CartAddCustomLineItemAction

Parameters:

quantity - value to be set

setSlug

public void setSlug(String slug)

Description copied from interface: CartAddCustomLineItemAction

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

Specified by:

setSlug in interface CartAddCustomLineItemAction

Parameters:

slug - value to be set

setTaxCategory

public void setTaxCategory(TaxCategoryResourceIdentifier taxCategory)

Description copied from interface: CartAddCustomLineItemAction

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

If TaxMode is Platform, this field must not be empty.

Specified by:

setTaxCategory in interface CartAddCustomLineItemAction

Parameters:

taxCategory - value to be set

setExternalTaxRate

public void setExternalTaxRate(ExternalTaxRateDraft externalTaxRate)

Description copied from interface: CartAddCustomLineItemAction

An external Tax Rate can be set if the Cart has External TaxMode.

Specified by:

setExternalTaxRate in interface CartAddCustomLineItemAction

Parameters:

externalTaxRate - value to be set

setShippingDetails

public void setShippingDetails(ItemShippingDetailsDraft shippingDetails)

Description copied from interface: CartAddCustomLineItemAction

Container for Custom Line Item-specific addresses.

Specified by:

setShippingDetails in interface CartAddCustomLineItemAction

Parameters:

shippingDetails - value to be set

setCustom

public void setCustom(CustomFieldsDraft custom)

Description copied from interface: CartAddCustomLineItemAction

Custom Fields for the Custom Line Item.

Specified by:

setCustom in interface CartAddCustomLineItemAction

Specified by:

setCustom in interface CustomizableDraft<CartAddCustomLineItemAction>

Parameters:

custom - value to be set

setPriceMode

public void setPriceMode(CustomLineItemPriceMode priceMode)

Description copied from interface: CartAddCustomLineItemAction

• If Standard, Cart Discounts with a matching CartDiscountCustomLineItemsTarget are applied to the Custom Line Item.
• If External, Cart Discounts are not considered on the Custom Line Item.

Specified by:

setPriceMode in interface CartAddCustomLineItemAction

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