Package com.commercetools.api.models.cart

Class LineItemDraftImpl

java.lang.Object

com.commercetools.api.models.cart.LineItemDraftImpl

All Implemented Interfaces:

LineItemDraft, CustomizableDraft<LineItemDraft>, io.vrap.rmf.base.client.Draft<LineItemDraft>, io.vrap.rmf.base.client.ModelBase

public class LineItemDraftImpl
extends Object
implements LineItemDraft, io.vrap.rmf.base.client.ModelBase

For Product Variant identification, either the productId and variantId, or sku must be provided.

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
LineItemDraftImpl()	create empty instance

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
ZonedDateTime	getAddedAt()	Date and time (UTC) the Product Variant is added to the Cart.
CustomFieldsDraft	getCustom()	Custom Fields for the Line Item.
ChannelResourceIdentifier	getDistributionChannel()	Used to select a Product Price.
Money	getExternalPrice()	Sets the LineItem price value, and the priceMode to ExternalPrice LineItemPriceMode.
ExternalTaxRateDraft	getExternalTaxRate()	External Tax Rate for the Line Item if the Cart has the External TaxMode.
ExternalLineItemTotalPrice	getExternalTotalPrice()	Sets the LineItem price and totalPrice values, and the priceMode to ExternalTotal LineItemPriceMode.
InventoryMode	getInventoryMode()	Inventory mode specific to the Line Item only, and valid for the entire quantity of the Line Item.
String	getKey()	User-defined unique identifier of the LineItem.
String	getProductId()	id of a published Product.
Long	getQuantity()	Quantity of the Product Variant to add to the Cart.
ItemShippingDetailsDraft	getShippingDetails()	Container for Line Item-specific addresses.
String	getSku()	sku of the ProductVariant.
ChannelResourceIdentifier	getSupplyChannel()	Used to identify Inventory entries that must be reserved.
Long	getVariantId()	id of the ProductVariant in the Product.
int	hashCode()
void	setAddedAt(ZonedDateTime addedAt)	Date and time (UTC) the Product Variant is added to the Cart.
void	setCustom(CustomFieldsDraft custom)	Custom Fields for the Line Item.
void	setDistributionChannel(ChannelResourceIdentifier distributionChannel)	Used to select a Product Price.
void	setExternalPrice(Money externalPrice)	Sets the LineItem price value, and the priceMode to ExternalPrice LineItemPriceMode.
void	setExternalTaxRate(ExternalTaxRateDraft externalTaxRate)	External Tax Rate for the Line Item if the Cart has the External TaxMode.
void	setExternalTotalPrice(ExternalLineItemTotalPrice externalTotalPrice)	Sets the LineItem price and totalPrice values, and the priceMode to ExternalTotal LineItemPriceMode.
void	setInventoryMode(InventoryMode inventoryMode)	Inventory mode specific to the Line Item only, and valid for the entire quantity of the Line Item.
void	setKey(String key)	User-defined unique identifier of the LineItem.
void	setProductId(String productId)	id of a published Product.
void	setQuantity(Long quantity)	Quantity of the Product Variant to add to the Cart.
void	setShippingDetails(ItemShippingDetailsDraft shippingDetails)	Container for Line Item-specific addresses.
void	setSku(String sku)	sku of the ProductVariant.
void	setSupplyChannel(ChannelResourceIdentifier supplyChannel)	Used to identify Inventory entries that must be reserved.
void	setVariantId(Long variantId)	id of the ProductVariant in the Product.

Methods inherited from class java.lang.Object

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

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

unwrapCustomizableDraft

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

withLineItemDraft

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

reflectionString, reflectionString

Constructor Details

LineItemDraftImpl

public LineItemDraftImpl()

create empty instance

Method Details

getKey

public String getKey()

User-defined unique identifier of the LineItem.

Specified by:

getKey in interface LineItemDraft

Returns:

key

getProductId

public String getProductId()

id of a published Product.

Specified by:

getProductId in interface LineItemDraft

Returns:

productId

getVariantId

public Long getVariantId()

id of the ProductVariant in the Product. If not provided, the Master Variant is used.

Specified by:

getVariantId in interface LineItemDraft

Returns:

variantId

getSku

public String getSku()

sku of the ProductVariant.

Specified by:

getSku in interface LineItemDraft

Returns:

sku

getQuantity

public Long getQuantity()

Quantity of the Product Variant to add to the Cart.

Specified by:

getQuantity in interface LineItemDraft

Returns:

quantity

getAddedAt

public ZonedDateTime getAddedAt()

Date and time (UTC) the Product Variant is added to the Cart. If not set, it defaults to the current date and time.

Optional for backwards compatibility reasons.

Specified by:

getAddedAt in interface LineItemDraft

Returns:

addedAt

getDistributionChannel

public ChannelResourceIdentifier getDistributionChannel()

Used to select a Product Price. The referenced Channel must have the ProductDistribution ChannelRoleEnum.

If the Cart is bound to a Store with distributionChannels set, the Channel must match one of the Store's distribution channels.

Specified by:

getDistributionChannel in interface LineItemDraft

Returns:

distributionChannel

getSupplyChannel

public ChannelResourceIdentifier getSupplyChannel()

Used to identify Inventory entries that must be reserved. The referenced Channel must have the InventorySupply ChannelRoleEnum.

Specified by:

getSupplyChannel in interface LineItemDraft

Returns:

supplyChannel

getExternalPrice

public Money getExternalPrice()

Sets the LineItem price value, and the priceMode to ExternalPrice LineItemPriceMode.

Specified by:

getExternalPrice in interface LineItemDraft

Returns:

externalPrice

getExternalTotalPrice

public ExternalLineItemTotalPrice getExternalTotalPrice()

Sets the LineItem price and totalPrice values, and the priceMode to ExternalTotal LineItemPriceMode.

Specified by:

getExternalTotalPrice in interface LineItemDraft

Returns:

externalTotalPrice

getExternalTaxRate

public ExternalTaxRateDraft getExternalTaxRate()

External Tax Rate for the Line Item if the Cart has the External TaxMode.

Specified by:

getExternalTaxRate in interface LineItemDraft

Returns:

externalTaxRate

getInventoryMode

public InventoryMode getInventoryMode()

Inventory mode specific to the Line Item only, and valid for the entire quantity of the Line Item. Set only if the inventory mode should be different from the inventoryMode specified on the Cart.

Specified by:

getInventoryMode in interface LineItemDraft

Returns:

inventoryMode

getShippingDetails

public ItemShippingDetailsDraft getShippingDetails()

Container for Line Item-specific addresses.

Specified by:

getShippingDetails in interface LineItemDraft

Returns:

shippingDetails

getCustom

public CustomFieldsDraft getCustom()

Custom Fields for the Line Item.

Specified by:

getCustom in interface CustomizableDraft<LineItemDraft>

Specified by:

getCustom in interface LineItemDraft

Returns:

custom

setKey

public void setKey(String key)

Description copied from interface: LineItemDraft

User-defined unique identifier of the LineItem.

Specified by:

setKey in interface LineItemDraft

Parameters:

key - value to be set

setProductId

public void setProductId(String productId)

Description copied from interface: LineItemDraft

id of a published Product.

Specified by:

setProductId in interface LineItemDraft

Parameters:

productId - value to be set

setVariantId

public void setVariantId(Long variantId)

Description copied from interface: LineItemDraft

id of the ProductVariant in the Product. If not provided, the Master Variant is used.

Specified by:

setVariantId in interface LineItemDraft

Parameters:

variantId - value to be set

setSku

public void setSku(String sku)

Description copied from interface: LineItemDraft

sku of the ProductVariant.

Specified by:

setSku in interface LineItemDraft

Parameters:

sku - value to be set

setQuantity

public void setQuantity(Long quantity)

Description copied from interface: LineItemDraft

Quantity of the Product Variant to add to the Cart.

Specified by:

setQuantity in interface LineItemDraft

Parameters:

quantity - value to be set

setAddedAt

public void setAddedAt(ZonedDateTime addedAt)

Description copied from interface: LineItemDraft

Date and time (UTC) the Product Variant is added to the Cart. If not set, it defaults to the current date and time.

Optional for backwards compatibility reasons.

Specified by:

setAddedAt in interface LineItemDraft

Parameters:

addedAt - value to be set

setDistributionChannel

public void setDistributionChannel(ChannelResourceIdentifier distributionChannel)

Description copied from interface: LineItemDraft

Used to select a Product Price. The referenced Channel must have the ProductDistribution ChannelRoleEnum.

If the Cart is bound to a Store with distributionChannels set, the Channel must match one of the Store's distribution channels.

Specified by:

setDistributionChannel in interface LineItemDraft

Parameters:

distributionChannel - value to be set

setSupplyChannel

public void setSupplyChannel(ChannelResourceIdentifier supplyChannel)

Description copied from interface: LineItemDraft

Used to identify Inventory entries that must be reserved. The referenced Channel must have the InventorySupply ChannelRoleEnum.

Specified by:

setSupplyChannel in interface LineItemDraft

Parameters:

supplyChannel - value to be set

setExternalPrice

public void setExternalPrice(Money externalPrice)

Description copied from interface: LineItemDraft

Sets the LineItem price value, and the priceMode to ExternalPrice LineItemPriceMode.

Specified by:

setExternalPrice in interface LineItemDraft

Parameters:

externalPrice - value to be set

setExternalTotalPrice

public void setExternalTotalPrice(ExternalLineItemTotalPrice externalTotalPrice)

Description copied from interface: LineItemDraft

Sets the LineItem price and totalPrice values, and the priceMode to ExternalTotal LineItemPriceMode.

Specified by:

setExternalTotalPrice in interface LineItemDraft

Parameters:

externalTotalPrice - value to be set

setExternalTaxRate

public void setExternalTaxRate(ExternalTaxRateDraft externalTaxRate)

Description copied from interface: LineItemDraft

External Tax Rate for the Line Item if the Cart has the External TaxMode.

Specified by:

setExternalTaxRate in interface LineItemDraft

Parameters:

externalTaxRate - value to be set

setInventoryMode

public void setInventoryMode(InventoryMode inventoryMode)

Description copied from interface: LineItemDraft

Inventory mode specific to the Line Item only, and valid for the entire quantity of the Line Item. Set only if the inventory mode should be different from the inventoryMode specified on the Cart.

Specified by:

setInventoryMode in interface LineItemDraft

Parameters:

inventoryMode - value to be set

setShippingDetails

public void setShippingDetails(ItemShippingDetailsDraft shippingDetails)

Description copied from interface: LineItemDraft

Container for Line Item-specific addresses.

Specified by:

setShippingDetails in interface LineItemDraft

Parameters:

shippingDetails - value to be set

setCustom

public void setCustom(CustomFieldsDraft custom)

Description copied from interface: LineItemDraft

Custom Fields for the Line Item.

Specified by:

setCustom in interface CustomizableDraft<LineItemDraft>

Specified by:

setCustom in interface LineItemDraft

Parameters:

custom - value to be set

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object