Package com.commercetools.api.models.cart

Class LineItemDraftBuilder

java.lang.Object

com.commercetools.api.models.cart.LineItemDraftBuilder

All Implemented Interfaces:

io.vrap.rmf.base.client.Builder<LineItemDraft>

public class LineItemDraftBuilder
extends Object
implements io.vrap.rmf.base.client.Builder<LineItemDraft>

LineItemDraftBuilder Example to create an instance using the builder pattern

     LineItemDraft lineItemDraft = LineItemDraft.builder()
             .build()
 

Constructor Summary

Constructors

Constructor	Description
LineItemDraftBuilder()

Method Summary

Modifier and Type	Method	Description
LineItemDraftBuilder	addedAt(ZonedDateTime addedAt)	Date and time (UTC) the Product Variant is added to the Cart.
LineItemDraft	build()	builds LineItemDraft with checking for non-null required values
LineItemDraft	buildUnchecked()	builds LineItemDraft without checking for non-null required values
LineItemDraftBuilder	custom(CustomFieldsDraft custom)	Custom Fields for the Line Item.
LineItemDraftBuilder	custom(Function<CustomFieldsDraftBuilder,CustomFieldsDraftBuilder> builder)	Custom Fields for the Line Item.
LineItemDraftBuilder	distributionChannel(ChannelResourceIdentifier distributionChannel)	Used to select a Product Price.
LineItemDraftBuilder	distributionChannel(Function<ChannelResourceIdentifierBuilder,ChannelResourceIdentifierBuilder> builder)	Used to select a Product Price.
LineItemDraftBuilder	externalPrice(Money externalPrice)	Sets the LineItem price value, and the priceMode to ExternalPrice LineItemPriceMode.
LineItemDraftBuilder	externalPrice(Function<MoneyBuilder,MoneyBuilder> builder)	Sets the LineItem price value, and the priceMode to ExternalPrice LineItemPriceMode.
LineItemDraftBuilder	externalTaxRate(ExternalTaxRateDraft externalTaxRate)	External Tax Rate for the Line Item if the Cart has the External TaxMode.
LineItemDraftBuilder	externalTaxRate(Function<ExternalTaxRateDraftBuilder,ExternalTaxRateDraftBuilder> builder)	External Tax Rate for the Line Item if the Cart has the External TaxMode.
LineItemDraftBuilder	externalTotalPrice(ExternalLineItemTotalPrice externalTotalPrice)	Sets the LineItem price and totalPrice values, and the priceMode to ExternalTotal LineItemPriceMode.
LineItemDraftBuilder	externalTotalPrice(Function<ExternalLineItemTotalPriceBuilder,ExternalLineItemTotalPriceBuilder> builder)	Sets the LineItem price and totalPrice values, and the priceMode to ExternalTotal LineItemPriceMode.
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.
LineItemDraftBuilder	inventoryMode(InventoryMode inventoryMode)	Inventory mode specific to the Line Item only, and valid for the entire quantity of the Line Item.
LineItemDraftBuilder	key(String key)	User-defined unique identifier of the LineItem.
static LineItemDraftBuilder	of()	factory method for an instance of LineItemDraftBuilder
static LineItemDraftBuilder	of(LineItemDraft template)	create builder for LineItemDraft instance
LineItemDraftBuilder	productId(String productId)	id of a published Product.
LineItemDraftBuilder	quantity(Long quantity)	Quantity of the Product Variant to add to the Cart.
LineItemDraftBuilder	shippingDetails(ItemShippingDetailsDraft shippingDetails)	Container for Line Item-specific addresses.
LineItemDraftBuilder	shippingDetails(Function<ItemShippingDetailsDraftBuilder,ItemShippingDetailsDraftBuilder> builder)	Container for Line Item-specific addresses.
LineItemDraftBuilder	sku(String sku)	sku of the ProductVariant.
LineItemDraftBuilder	supplyChannel(ChannelResourceIdentifier supplyChannel)	Used to identify Inventory entries that must be reserved.
LineItemDraftBuilder	supplyChannel(Function<ChannelResourceIdentifierBuilder,ChannelResourceIdentifierBuilder> builder)	Used to identify Inventory entries that must be reserved.
LineItemDraftBuilder	variantId(Long variantId)	id of the ProductVariant in the Product.
LineItemDraftBuilder	withCustom(Function<CustomFieldsDraftBuilder,CustomFieldsDraft> builder)	Custom Fields for the Line Item.
LineItemDraftBuilder	withDistributionChannel(Function<ChannelResourceIdentifierBuilder,ChannelResourceIdentifier> builder)	Used to select a Product Price.
LineItemDraftBuilder	withExternalPrice(Function<MoneyBuilder,Money> builder)	Sets the LineItem price value, and the priceMode to ExternalPrice LineItemPriceMode.
LineItemDraftBuilder	withExternalTaxRate(Function<ExternalTaxRateDraftBuilder,ExternalTaxRateDraft> builder)	External Tax Rate for the Line Item if the Cart has the External TaxMode.
LineItemDraftBuilder	withExternalTotalPrice(Function<ExternalLineItemTotalPriceBuilder,ExternalLineItemTotalPrice> builder)	Sets the LineItem price and totalPrice values, and the priceMode to ExternalTotal LineItemPriceMode.
LineItemDraftBuilder	withShippingDetails(Function<ItemShippingDetailsDraftBuilder,ItemShippingDetailsDraft> builder)	Container for Line Item-specific addresses.
LineItemDraftBuilder	withSupplyChannel(Function<ChannelResourceIdentifierBuilder,ChannelResourceIdentifier> builder)	Used to identify Inventory entries that must be reserved.

Methods inherited from class java.lang.Object

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

Constructor Details

LineItemDraftBuilder

public LineItemDraftBuilder()

Method Details

key

public LineItemDraftBuilder key(@Nullable
 String key)

User-defined unique identifier of the LineItem.

Parameters:

key - value to be set

Returns:

Builder

productId

public LineItemDraftBuilder productId(@Nullable
 String productId)

id of a published Product.

Parameters:

productId - value to be set

Returns:

Builder

variantId

public LineItemDraftBuilder variantId(@Nullable
 Long variantId)

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

Parameters:

variantId - value to be set

Returns:

Builder

sku

public LineItemDraftBuilder sku(@Nullable
 String sku)

sku of the ProductVariant.

Parameters:

sku - value to be set

Returns:

Builder

quantity

public LineItemDraftBuilder quantity(@Nullable
 Long quantity)

Quantity of the Product Variant to add to the Cart.

Parameters:

quantity - value to be set

Returns:

Builder

addedAt

public LineItemDraftBuilder addedAt(@Nullable
 ZonedDateTime addedAt)

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.

Parameters:

addedAt - value to be set

Returns:

Builder

distributionChannel

public LineItemDraftBuilder distributionChannel(Function<ChannelResourceIdentifierBuilder,ChannelResourceIdentifierBuilder> builder)

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.

Parameters:

builder - function to build the distributionChannel value

Returns:

Builder

withDistributionChannel

public LineItemDraftBuilder withDistributionChannel(Function<ChannelResourceIdentifierBuilder,ChannelResourceIdentifier> builder)

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.

Parameters:

builder - function to build the distributionChannel value

Returns:

Builder

distributionChannel

public LineItemDraftBuilder distributionChannel(@Nullable
 ChannelResourceIdentifier distributionChannel)

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.

Parameters:

distributionChannel - value to be set

Returns:

Builder

supplyChannel

public LineItemDraftBuilder supplyChannel(Function<ChannelResourceIdentifierBuilder,ChannelResourceIdentifierBuilder> builder)

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

Parameters:

builder - function to build the supplyChannel value

Returns:

Builder

withSupplyChannel

public LineItemDraftBuilder withSupplyChannel(Function<ChannelResourceIdentifierBuilder,ChannelResourceIdentifier> builder)

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

Parameters:

builder - function to build the supplyChannel value

Returns:

Builder

supplyChannel

public LineItemDraftBuilder supplyChannel(@Nullable
 ChannelResourceIdentifier supplyChannel)

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

Parameters:

supplyChannel - value to be set

Returns:

Builder

externalPrice

public LineItemDraftBuilder externalPrice(Function<MoneyBuilder,MoneyBuilder> builder)

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

Parameters:

builder - function to build the externalPrice value

Returns:

Builder

withExternalPrice

public LineItemDraftBuilder withExternalPrice(Function<MoneyBuilder,Money> builder)

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

Parameters:

builder - function to build the externalPrice value

Returns:

Builder

externalPrice

public LineItemDraftBuilder externalPrice(@Nullable
 Money externalPrice)

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

Parameters:

externalPrice - value to be set

Returns:

Builder

externalTotalPrice

public LineItemDraftBuilder externalTotalPrice(Function<ExternalLineItemTotalPriceBuilder,ExternalLineItemTotalPriceBuilder> builder)

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

Parameters:

builder - function to build the externalTotalPrice value

Returns:

Builder

withExternalTotalPrice

public LineItemDraftBuilder withExternalTotalPrice(Function<ExternalLineItemTotalPriceBuilder,ExternalLineItemTotalPrice> builder)

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

Parameters:

builder - function to build the externalTotalPrice value

Returns:

Builder

externalTotalPrice

public LineItemDraftBuilder externalTotalPrice(@Nullable
 ExternalLineItemTotalPrice externalTotalPrice)

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

Parameters:

externalTotalPrice - value to be set

Returns:

Builder

externalTaxRate

public LineItemDraftBuilder externalTaxRate(Function<ExternalTaxRateDraftBuilder,ExternalTaxRateDraftBuilder> builder)

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

Parameters:

builder - function to build the externalTaxRate value

Returns:

Builder

withExternalTaxRate

public LineItemDraftBuilder withExternalTaxRate(Function<ExternalTaxRateDraftBuilder,ExternalTaxRateDraft> builder)

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

Parameters:

builder - function to build the externalTaxRate value

Returns:

Builder

externalTaxRate

public LineItemDraftBuilder externalTaxRate(@Nullable
 ExternalTaxRateDraft externalTaxRate)

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

Parameters:

externalTaxRate - value to be set

Returns:

Builder

inventoryMode

public LineItemDraftBuilder inventoryMode(@Nullable
 InventoryMode inventoryMode)

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.

Parameters:

inventoryMode - value to be set

Returns:

Builder

shippingDetails

public LineItemDraftBuilder shippingDetails(Function<ItemShippingDetailsDraftBuilder,ItemShippingDetailsDraftBuilder> builder)

Container for Line Item-specific addresses.

Parameters:

builder - function to build the shippingDetails value

Returns:

Builder

withShippingDetails

public LineItemDraftBuilder withShippingDetails(Function<ItemShippingDetailsDraftBuilder,ItemShippingDetailsDraft> builder)

Container for Line Item-specific addresses.

Parameters:

builder - function to build the shippingDetails value

Returns:

Builder

shippingDetails

public LineItemDraftBuilder shippingDetails(@Nullable
 ItemShippingDetailsDraft shippingDetails)

Container for Line Item-specific addresses.

Parameters:

shippingDetails - value to be set

Returns:

Builder

custom

public LineItemDraftBuilder custom(Function<CustomFieldsDraftBuilder,CustomFieldsDraftBuilder> builder)

Custom Fields for the Line Item.

Parameters:

builder - function to build the custom value

Returns:

Builder

withCustom

public LineItemDraftBuilder withCustom(Function<CustomFieldsDraftBuilder,CustomFieldsDraft> builder)

Custom Fields for the Line Item.

Parameters:

builder - function to build the custom value

Returns:

Builder

custom

public LineItemDraftBuilder custom(@Nullable
 CustomFieldsDraft custom)

Custom Fields for the Line Item.

Parameters:

custom - value to be set

Returns:

Builder

getKey

@Nullable
public String getKey()

User-defined unique identifier of the LineItem.

Returns:

key

getProductId

@Nullable
public String getProductId()

id of a published Product.

Returns:

productId

getVariantId

@Nullable
public Long getVariantId()

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

Returns:

variantId

getSku

@Nullable
public String getSku()

sku of the ProductVariant.

Returns:

sku

getQuantity

@Nullable
public Long getQuantity()

Quantity of the Product Variant to add to the Cart.

Returns:

quantity

getAddedAt

@Nullable
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.

Returns:

addedAt

getDistributionChannel

@Nullable
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.

Returns:

distributionChannel

getSupplyChannel

@Nullable
public ChannelResourceIdentifier getSupplyChannel()

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

Returns:

supplyChannel

getExternalPrice

@Nullable
public Money getExternalPrice()

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

Returns:

externalPrice

getExternalTotalPrice

@Nullable
public ExternalLineItemTotalPrice getExternalTotalPrice()

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

Returns:

externalTotalPrice

getExternalTaxRate

@Nullable
public ExternalTaxRateDraft getExternalTaxRate()

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

Returns:

externalTaxRate

getInventoryMode

@Nullable
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.

Returns:

inventoryMode

getShippingDetails

@Nullable
public ItemShippingDetailsDraft getShippingDetails()

Container for Line Item-specific addresses.

Returns:

shippingDetails

getCustom

@Nullable
public CustomFieldsDraft getCustom()

Custom Fields for the Line Item.

Returns:

custom

build

public LineItemDraft build()

builds LineItemDraft with checking for non-null required values

Specified by:

build in interface io.vrap.rmf.base.client.Builder<LineItemDraft>

Returns:

LineItemDraft

buildUnchecked

public LineItemDraft buildUnchecked()

builds LineItemDraft without checking for non-null required values

Returns:

LineItemDraft

of

public static LineItemDraftBuilder of()

factory method for an instance of LineItemDraftBuilder

Returns:

builder

of

public static LineItemDraftBuilder of(LineItemDraft template)

create builder for LineItemDraft instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder