Package com.commercetools.api.models.order

Class LineItemImportDraftBuilder

java.lang.Object

com.commercetools.api.models.order.LineItemImportDraftBuilder

All Implemented Interfaces:

Builder<LineItemImportDraft>

public class LineItemImportDraftBuilder
extends Object
implements Builder<LineItemImportDraft>

LineItemImportDraftBuilder Example to create an instance using the builder pattern

     LineItemImportDraft lineItemImportDraft = LineItemImportDraft.builder()
             .name(nameBuilder -> nameBuilder)
             .variant(variantBuilder -> variantBuilder)
             .quantity(0.3)
             .price(priceBuilder -> priceBuilder)
             .build()
 

Constructor Summary

Constructors

Constructor	Description
LineItemImportDraftBuilder()

Method Summary

Modifier and Type	Method	Description
LineItemImportDraftBuilder	addState(Function<ItemStateBuilder,ItemState> builder)	States of the Line Item.
LineItemImportDraft	build()	builds LineItemImportDraft with checking for non-null required values
LineItemImportDraft	buildUnchecked()	builds LineItemImportDraft without checking for non-null required values
LineItemImportDraftBuilder	custom(CustomFieldsDraft custom)	Custom Fields of the LineItem.
LineItemImportDraftBuilder	custom(Function<CustomFieldsDraftBuilder,CustomFieldsDraftBuilder> builder)	Custom Fields of the LineItem.
LineItemImportDraftBuilder	distributionChannel(ChannelResourceIdentifier distributionChannel)	The Channel used to select a Price.
LineItemImportDraftBuilder	distributionChannel(Function<ChannelResourceIdentifierBuilder,ChannelResourceIdentifierBuilder> builder)	The Channel used to select a Price.
CustomFieldsDraft	getCustom()	Custom Fields of the LineItem.
ChannelResourceIdentifier	getDistributionChannel()	The Channel used to select a Price.
InventoryMode	getInventoryMode()	Inventory mode specific to the LineItem, valid for the entire quantity of the LineItem.
String	getKey()	User-defined unique identifier of the Line Item.
LocalizedString	getName()	Name of the Line Item.
PriceDraft	getPrice()	The Line Item price for quantity = 1.
String	getProductId()	id of the Product the Product Variant belongs to.
Long	getQuantity()	The number of Product Variants in the LineItem.
ItemShippingDetailsDraft	getShippingDetails()	Container for Line Item-specific addresses.
List<ItemState>	getState()	States of the Line Item.
ChannelResourceIdentifier	getSupplyChannel()	The Channel used to supply Line Items.
TaxRate	getTaxRate()	The tax rate used to calculate the taxedPrice of the Order.
ProductVariantImportDraft	getVariant()	The Product Variant to use as a Line Item.
LineItemImportDraftBuilder	inventoryMode(InventoryMode inventoryMode)	Inventory mode specific to the LineItem, valid for the entire quantity of the LineItem.
LineItemImportDraftBuilder	key(String key)	User-defined unique identifier of the Line Item.
LineItemImportDraftBuilder	name(LocalizedString name)	Name of the Line Item.
LineItemImportDraftBuilder	name(Function<LocalizedStringBuilder,LocalizedStringBuilder> builder)	Name of the Line Item.
static LineItemImportDraftBuilder	of()	factory method for an instance of LineItemImportDraftBuilder
static LineItemImportDraftBuilder	of(LineItemImportDraft template)	create builder for LineItemImportDraft instance
LineItemImportDraftBuilder	plusState(ItemState... state)	States of the Line Item.
LineItemImportDraftBuilder	plusState(Function<ItemStateBuilder,ItemStateBuilder> builder)	States of the Line Item.
LineItemImportDraftBuilder	price(PriceDraft price)	The Line Item price for quantity = 1.
LineItemImportDraftBuilder	price(Function<PriceDraftBuilder,PriceDraftBuilder> builder)	The Line Item price for quantity = 1.
LineItemImportDraftBuilder	productId(String productId)	id of the Product the Product Variant belongs to.
LineItemImportDraftBuilder	quantity(Long quantity)	The number of Product Variants in the LineItem.
LineItemImportDraftBuilder	setState(Function<ItemStateBuilder,ItemState> builder)	States of the Line Item.
LineItemImportDraftBuilder	shippingDetails(ItemShippingDetailsDraft shippingDetails)	Container for Line Item-specific addresses.
LineItemImportDraftBuilder	shippingDetails(Function<ItemShippingDetailsDraftBuilder,ItemShippingDetailsDraftBuilder> builder)	Container for Line Item-specific addresses.
LineItemImportDraftBuilder	state(ItemState... state)	States of the Line Item.
LineItemImportDraftBuilder	state(List<ItemState> state)	States of the Line Item.
LineItemImportDraftBuilder	supplyChannel(ChannelResourceIdentifier supplyChannel)	The Channel used to supply Line Items.
LineItemImportDraftBuilder	supplyChannel(Function<ChannelResourceIdentifierBuilder,ChannelResourceIdentifierBuilder> builder)	The Channel used to supply Line Items.
LineItemImportDraftBuilder	taxRate(TaxRate taxRate)	The tax rate used to calculate the taxedPrice of the Order.
LineItemImportDraftBuilder	taxRate(Function<TaxRateBuilder,TaxRateBuilder> builder)	The tax rate used to calculate the taxedPrice of the Order.
LineItemImportDraftBuilder	variant(ProductVariantImportDraft variant)	The Product Variant to use as a Line Item.
LineItemImportDraftBuilder	variant(Function<ProductVariantImportDraftBuilder,ProductVariantImportDraftBuilder> builder)	The Product Variant to use as a Line Item.
LineItemImportDraftBuilder	withCustom(Function<CustomFieldsDraftBuilder,CustomFieldsDraft> builder)	Custom Fields of the LineItem.
LineItemImportDraftBuilder	withDistributionChannel(Function<ChannelResourceIdentifierBuilder,ChannelResourceIdentifier> builder)	The Channel used to select a Price.
LineItemImportDraftBuilder	withName(Function<LocalizedStringBuilder,LocalizedString> builder)	Name of the Line Item.
LineItemImportDraftBuilder	withPrice(Function<PriceDraftBuilder,PriceDraft> builder)	The Line Item price for quantity = 1.
LineItemImportDraftBuilder	withShippingDetails(Function<ItemShippingDetailsDraftBuilder,ItemShippingDetailsDraft> builder)	Container for Line Item-specific addresses.
LineItemImportDraftBuilder	withState(Function<ItemStateBuilder,ItemStateBuilder> builder)	States of the Line Item.
LineItemImportDraftBuilder	withSupplyChannel(Function<ChannelResourceIdentifierBuilder,ChannelResourceIdentifier> builder)	The Channel used to supply Line Items.
LineItemImportDraftBuilder	withTaxRate(Function<TaxRateBuilder,TaxRate> builder)	The tax rate used to calculate the taxedPrice of the Order.
LineItemImportDraftBuilder	withVariant(Function<ProductVariantImportDraftBuilder,ProductVariantImportDraft> builder)	The Product Variant to use as a Line Item.

Methods inherited from class java.lang.Object

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

Constructor Details

LineItemImportDraftBuilder

public LineItemImportDraftBuilder()

Method Details

name

public LineItemImportDraftBuilder name(Function<LocalizedStringBuilder,LocalizedStringBuilder> builder)

Name of the Line Item.

Parameters:

builder - function to build the name value

Returns:

Builder

withName

public LineItemImportDraftBuilder withName(Function<LocalizedStringBuilder,LocalizedString> builder)

Name of the Line Item.

Parameters:

builder - function to build the name value

Returns:

Builder

name

public LineItemImportDraftBuilder name(LocalizedString name)

Name of the Line Item.

Parameters:

name - value to be set

Returns:

Builder

key

public LineItemImportDraftBuilder key(@Nullable
 String key)

User-defined unique identifier of the Line Item.

Parameters:

key - value to be set

Returns:

Builder

variant

public LineItemImportDraftBuilder variant(Function<ProductVariantImportDraftBuilder,ProductVariantImportDraftBuilder> builder)

The Product Variant to use as a Line Item.

Parameters:

builder - function to build the variant value

Returns:

Builder

withVariant

public LineItemImportDraftBuilder withVariant(Function<ProductVariantImportDraftBuilder,ProductVariantImportDraft> builder)

The Product Variant to use as a Line Item.

Parameters:

builder - function to build the variant value

Returns:

Builder

variant

public LineItemImportDraftBuilder variant(ProductVariantImportDraft variant)

The Product Variant to use as a Line Item.

Parameters:

variant - value to be set

Returns:

Builder

productId

public LineItemImportDraftBuilder productId(@Nullable
 String productId)

id of the Product the Product Variant belongs to.

If provided, you must also set variant.id.

Parameters:

productId - value to be set

Returns:

Builder

quantity

public LineItemImportDraftBuilder quantity(Long quantity)

The number of Product Variants in the LineItem. Can be a negative value.

Parameters:

quantity - value to be set

Returns:

Builder

price

public LineItemImportDraftBuilder price(Function<PriceDraftBuilder,PriceDraftBuilder> builder)

The Line Item price for quantity = 1. The amount can be negative.

Parameters:

builder - function to build the price value

Returns:

Builder

withPrice

public LineItemImportDraftBuilder withPrice(Function<PriceDraftBuilder,PriceDraft> builder)

The Line Item price for quantity = 1. The amount can be negative.

Parameters:

builder - function to build the price value

Returns:

Builder

price

public LineItemImportDraftBuilder price(PriceDraft price)

The Line Item price for quantity = 1. The amount can be negative.

Parameters:

price - value to be set

Returns:

Builder

taxRate

public LineItemImportDraftBuilder taxRate(Function<TaxRateBuilder,TaxRateBuilder> builder)

The tax rate used to calculate the taxedPrice of the Order.

Parameters:

builder - function to build the taxRate value

Returns:

Builder

withTaxRate

public LineItemImportDraftBuilder withTaxRate(Function<TaxRateBuilder,TaxRate> builder)

The tax rate used to calculate the taxedPrice of the Order.

Parameters:

builder - function to build the taxRate value

Returns:

Builder

taxRate

public LineItemImportDraftBuilder taxRate(@Nullable
 TaxRate taxRate)

The tax rate used to calculate the taxedPrice of the Order.

Parameters:

taxRate - value to be set

Returns:

Builder

distributionChannel

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

The Channel used to select a Price. This Channel must have the ProductDistribution role.

Parameters:

builder - function to build the distributionChannel value

Returns:

Builder

withDistributionChannel

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

The Channel used to select a Price. This Channel must have the ProductDistribution role.

Parameters:

builder - function to build the distributionChannel value

Returns:

Builder

distributionChannel

public LineItemImportDraftBuilder distributionChannel(@Nullable
 ChannelResourceIdentifier distributionChannel)

The Channel used to select a Price. This Channel must have the ProductDistribution role.

Parameters:

distributionChannel - value to be set

Returns:

Builder

supplyChannel

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

The Channel used to supply Line Items. By providing supply Channel information, you can uniquely identify Inventory entries that should be reserved. This Channel must have the InventorySupply role.

Parameters:

builder - function to build the supplyChannel value

Returns:

Builder

withSupplyChannel

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

The Channel used to supply Line Items. By providing supply Channel information, you can uniquely identify Inventory entries that should be reserved. This Channel must have the InventorySupply role.

Parameters:

builder - function to build the supplyChannel value

Returns:

Builder

supplyChannel

public LineItemImportDraftBuilder supplyChannel(@Nullable
 ChannelResourceIdentifier supplyChannel)

The Channel used to supply Line Items. By providing supply Channel information, you can uniquely identify Inventory entries that should be reserved. This Channel must have the InventorySupply role.

Parameters:

supplyChannel - value to be set

Returns:

Builder

inventoryMode

public LineItemImportDraftBuilder inventoryMode(@Nullable
 InventoryMode inventoryMode)

Inventory mode specific to the LineItem, valid for the entire quantity of the LineItem. Set only if Inventory mode should be different from the inventoryMode specified on the OrderImportDraft.

Parameters:

inventoryMode - value to be set

Returns:

Builder

shippingDetails

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

Container for Line Item-specific addresses.

Parameters:

builder - function to build the shippingDetails value

Returns:

Builder

withShippingDetails

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

Container for Line Item-specific addresses.

Parameters:

builder - function to build the shippingDetails value

Returns:

Builder

shippingDetails

public LineItemImportDraftBuilder shippingDetails(@Nullable
 ItemShippingDetailsDraft shippingDetails)

Container for Line Item-specific addresses.

Parameters:

shippingDetails - value to be set

Returns:

Builder

state

public LineItemImportDraftBuilder state(@Nullable
 ItemState... state)

States of the Line Item.

Parameters:

state - value to be set

Returns:

Builder

state

public LineItemImportDraftBuilder state(@Nullable
 List<ItemState> state)

States of the Line Item.

Parameters:

state - value to be set

Returns:

Builder

plusState

public LineItemImportDraftBuilder plusState(@Nullable
 ItemState... state)

States of the Line Item.

Parameters:

state - value to be set

Returns:

Builder

plusState

public LineItemImportDraftBuilder plusState(Function<ItemStateBuilder,ItemStateBuilder> builder)

States of the Line Item.

Parameters:

builder - function to build the state value

Returns:

Builder

withState

public LineItemImportDraftBuilder withState(Function<ItemStateBuilder,ItemStateBuilder> builder)

States of the Line Item.

Parameters:

builder - function to build the state value

Returns:

Builder

addState

public LineItemImportDraftBuilder addState(Function<ItemStateBuilder,ItemState> builder)

States of the Line Item.

Parameters:

builder - function to build the state value

Returns:

Builder

setState

public LineItemImportDraftBuilder setState(Function<ItemStateBuilder,ItemState> builder)

States of the Line Item.

Parameters:

builder - function to build the state value

Returns:

Builder

custom

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

Custom Fields of the LineItem.

Parameters:

builder - function to build the custom value

Returns:

Builder

withCustom

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

Custom Fields of the LineItem.

Parameters:

builder - function to build the custom value

Returns:

Builder

custom

public LineItemImportDraftBuilder custom(@Nullable
 CustomFieldsDraft custom)

Custom Fields of the LineItem.

Parameters:

custom - value to be set

Returns:

Builder

getName

public LocalizedString getName()

Name of the Line Item.

Returns:

name

getKey

@Nullable
public String getKey()

User-defined unique identifier of the Line Item.

Returns:

key

getVariant

public ProductVariantImportDraft getVariant()

The Product Variant to use as a Line Item.

Returns:

variant

getProductId

@Nullable
public String getProductId()

id of the Product the Product Variant belongs to.

If provided, you must also set variant.id.

Returns:

productId

getQuantity

public Long getQuantity()

The number of Product Variants in the LineItem. Can be a negative value.

Returns:

quantity

getPrice

public PriceDraft getPrice()

The Line Item price for quantity = 1. The amount can be negative.

Returns:

price

getTaxRate

@Nullable
public TaxRate getTaxRate()

The tax rate used to calculate the taxedPrice of the Order.

Returns:

taxRate

getDistributionChannel

@Nullable
public ChannelResourceIdentifier getDistributionChannel()

The Channel used to select a Price. This Channel must have the ProductDistribution role.

Returns:

distributionChannel

getSupplyChannel

@Nullable
public ChannelResourceIdentifier getSupplyChannel()

The Channel used to supply Line Items. By providing supply Channel information, you can uniquely identify Inventory entries that should be reserved. This Channel must have the InventorySupply role.

Returns:

supplyChannel

getInventoryMode

@Nullable
public InventoryMode getInventoryMode()

Inventory mode specific to the LineItem, valid for the entire quantity of the LineItem. Set only if Inventory mode should be different from the inventoryMode specified on the OrderImportDraft.

Returns:

inventoryMode

getShippingDetails

@Nullable
public ItemShippingDetailsDraft getShippingDetails()

Container for Line Item-specific addresses.

Returns:

shippingDetails

getState

@Nullable
public List<ItemState> getState()

States of the Line Item.

Returns:

state

getCustom

@Nullable
public CustomFieldsDraft getCustom()

Custom Fields of the LineItem.

Returns:

custom

build

public LineItemImportDraft build()

builds LineItemImportDraft with checking for non-null required values

Specified by:

build in interface Builder<LineItemImportDraft>

Returns:

LineItemImportDraft

buildUnchecked

public LineItemImportDraft buildUnchecked()

builds LineItemImportDraft without checking for non-null required values

Returns:

LineItemImportDraft

of

public static LineItemImportDraftBuilder of()

factory method for an instance of LineItemImportDraftBuilder

Returns:

builder

of

public static LineItemImportDraftBuilder of(LineItemImportDraft template)

create builder for LineItemImportDraft instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder