Package com.commercetools.api.models.order

Interface LineItemImportDraft

All Superinterfaces:

CustomizableDraft<LineItemImportDraft>, io.vrap.rmf.base.client.Draft<LineItemImportDraft>

All Known Implementing Classes:

LineItemImportDraftImpl

public interface LineItemImportDraft
extends CustomizableDraft<LineItemImportDraft>, io.vrap.rmf.base.client.Draft<LineItemImportDraft>

LineItemImportDraft Example to create an instance using the builder pattern

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

Method Summary

Modifier and Type	Method	Description
static LineItemImportDraftBuilder	builder()	builder factory method for LineItemImportDraft
static LineItemImportDraftBuilder	builder(LineItemImportDraft template)	create builder for LineItemImportDraft instance
static LineItemImportDraft	deepCopy(LineItemImportDraft template)	factory method to create a deep copy of LineItemImportDraft
@Valid CustomFieldsDraft	getCustom()	The custom fields.
@Valid ChannelResourceIdentifier	getDistributionChannel()	The channel is used to select a ProductPrice.
InventoryMode	getInventoryMode()	Inventory mode specific to the line item only, valid for the entire quantity of the line item.
@NotNull @Valid LocalizedString	getName()	The product name.
@NotNull @Valid PriceDraft	getPrice()
String	getProductId()	ID of the existing product.
@NotNull Long	getQuantity()
@Valid ItemShippingDetailsDraft	getShippingDetails()
@Valid List<ItemState>	getState()
@Valid ChannelResourceIdentifier	getSupplyChannel()	Connection to a particular supplier.
@Valid TaxRate	getTaxRate()
@NotNull @Valid ProductVariantImportDraft	getVariant()
static LineItemImportDraft	of()	factory method
static LineItemImportDraft	of(LineItemImportDraft template)	factory method to create a shallow copy LineItemImportDraft
void	setCustom(CustomFieldsDraft custom)	The custom fields.
void	setDistributionChannel(ChannelResourceIdentifier distributionChannel)	The channel is used to select a ProductPrice.
void	setInventoryMode(InventoryMode inventoryMode)	Inventory mode specific to the line item only, valid for the entire quantity of the line item.
void	setName(LocalizedString name)	The product name.
void	setPrice(PriceDraft price)	set price
void	setProductId(String productId)	ID of the existing product.
void	setQuantity(Long quantity)	set quantity
void	setShippingDetails(ItemShippingDetailsDraft shippingDetails)	set shippingDetails
void	setState(ItemState... state)	set state
void	setState(List<ItemState> state)	set state
void	setSupplyChannel(ChannelResourceIdentifier supplyChannel)	Connection to a particular supplier.
void	setTaxRate(TaxRate taxRate)	set taxRate
void	setVariant(ProductVariantImportDraft variant)	set variant
static com.fasterxml.jackson.core.type.TypeReference<LineItemImportDraft>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withLineItemImportDraft(Function<LineItemImportDraft,T> helper)	accessor map function

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

unwrapCustomizableDraft

Method Details

getProductId

String getProductId()

ID of the existing product. You also need to specify the ID of the variant if this property is set or alternatively you can just specify SKU of the product variant.

Returns:

productId

getName

@NotNull
@Valid
@NotNull @Valid LocalizedString getName()

The product name.

Returns:

name

getVariant

@NotNull
@Valid
@NotNull @Valid ProductVariantImportDraft getVariant()

Returns:

variant

getPrice

@NotNull
@Valid
@NotNull @Valid PriceDraft getPrice()

Returns:

price

getQuantity

@NotNull
@NotNull Long getQuantity()

Returns:

quantity

getState

@Valid
@Valid List<ItemState> getState()

Returns:

state

getSupplyChannel

@Valid
@Valid ChannelResourceIdentifier getSupplyChannel()

Connection to a particular supplier. By providing supply channel information, you can uniquely identify inventory entries that should be reserved. The provided channel should have the InventorySupply role.

Returns:

supplyChannel

getDistributionChannel

@Valid
@Valid ChannelResourceIdentifier getDistributionChannel()

The channel is used to select a ProductPrice. The provided channel should have the ProductDistribution role.

Returns:

distributionChannel

getTaxRate

@Valid
@Valid TaxRate getTaxRate()

Returns:

taxRate

getCustom

@Valid
@Valid CustomFieldsDraft getCustom()

The custom fields.

Specified by:

getCustom in interface CustomizableDraft<LineItemImportDraft>

Returns:

custom

getInventoryMode

InventoryMode getInventoryMode()

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

Returns:

inventoryMode

getShippingDetails

@Valid
@Valid ItemShippingDetailsDraft getShippingDetails()

Returns:

shippingDetails

setProductId

void setProductId(String productId)

ID of the existing product. You also need to specify the ID of the variant if this property is set or alternatively you can just specify SKU of the product variant.

Parameters:

productId - value to be set

setName

void setName(LocalizedString name)

The product name.

Parameters:

name - value to be set

setVariant

void setVariant(ProductVariantImportDraft variant)

set variant

Parameters:

variant - value to be set

setPrice

void setPrice(PriceDraft price)

set price

Parameters:

price - value to be set

setQuantity

void setQuantity(Long quantity)

set quantity

Parameters:

quantity - value to be set

setState

void setState(ItemState... state)

set state

Parameters:

state - values to be set

setState

void setState(List<ItemState> state)

set state

Parameters:

state - values to be set

setSupplyChannel

void setSupplyChannel(ChannelResourceIdentifier supplyChannel)

Connection to a particular supplier. By providing supply channel information, you can uniquely identify inventory entries that should be reserved. The provided channel should have the InventorySupply role.

Parameters:

supplyChannel - value to be set

setDistributionChannel

void setDistributionChannel(ChannelResourceIdentifier distributionChannel)

The channel is used to select a ProductPrice. The provided channel should have the ProductDistribution role.

Parameters:

distributionChannel - value to be set

setTaxRate

void setTaxRate(TaxRate taxRate)

set taxRate

Parameters:

taxRate - value to be set

setCustom

void setCustom(CustomFieldsDraft custom)

The custom fields.

Specified by:

setCustom in interface CustomizableDraft<LineItemImportDraft>

Parameters:

custom - value to be set

setInventoryMode

void setInventoryMode(InventoryMode inventoryMode)

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

Parameters:

inventoryMode - value to be set

setShippingDetails

void setShippingDetails(ItemShippingDetailsDraft shippingDetails)

set shippingDetails

Parameters:

shippingDetails - value to be set

of

static LineItemImportDraft of()

factory method

Returns:

instance of LineItemImportDraft

of

static LineItemImportDraft of(LineItemImportDraft template)

factory method to create a shallow copy LineItemImportDraft

Parameters:

template - instance to be copied

Returns:

copy instance

deepCopy

@Nullable
static LineItemImportDraft deepCopy(@Nullable
 LineItemImportDraft template)

factory method to create a deep copy of LineItemImportDraft

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static LineItemImportDraftBuilder builder()

builder factory method for LineItemImportDraft

Returns:

builder

builder

static LineItemImportDraftBuilder builder(LineItemImportDraft template)

create builder for LineItemImportDraft instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withLineItemImportDraft

default <T> T withLineItemImportDraft(Function<LineItemImportDraft,T> helper)

accessor map function

Type Parameters:

T - mapped type

Parameters:

helper - function to map the object

Returns:

mapped value

typeReference

static com.fasterxml.jackson.core.type.TypeReference<LineItemImportDraft> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference