Package com.commercetools.api.models.me

Class MyLineItemDraftBuilder

java.lang.Object

com.commercetools.api.models.me.MyLineItemDraftBuilder

All Implemented Interfaces:

Builder<MyLineItemDraft>

public class MyLineItemDraftBuilder
extends Object
implements Builder<MyLineItemDraft>

MyLineItemDraftBuilder Example to create an instance using the builder pattern

     MyLineItemDraft myLineItemDraft = MyLineItemDraft.builder()
             .build()
 

Constructor Summary

Constructors

Constructor	Description
MyLineItemDraftBuilder()

Method Summary

Modifier and Type	Method	Description
MyLineItemDraftBuilder	addedAt(ZonedDateTime addedAt)	Date and time (UTC) the Product Variant is added to the Cart.
MyLineItemDraft	build()	builds MyLineItemDraft with checking for non-null required values
MyLineItemDraft	buildUnchecked()	builds MyLineItemDraft without checking for non-null required values
MyLineItemDraftBuilder	custom(CustomFieldsDraft custom)	Custom Fields for the Cart.
MyLineItemDraftBuilder	custom(Function<CustomFieldsDraftBuilder,CustomFieldsDraftBuilder> builder)	Custom Fields for the Cart.
MyLineItemDraftBuilder	distributionChannel(ChannelResourceIdentifier distributionChannel)	Used to select a Product Price.
MyLineItemDraftBuilder	distributionChannel(Function<ChannelResourceIdentifierBuilder,ChannelResourceIdentifierBuilder> builder)	Used to select a Product Price.
ZonedDateTime	getAddedAt()	Date and time (UTC) the Product Variant is added to the Cart.
CustomFieldsDraft	getCustom()	Custom Fields for the Cart.
ChannelResourceIdentifier	getDistributionChannel()	Used to select a Product Price.
String	getKey()	User-defined unique identifier of the LineItem.
String	getProductId()	id of the Product.
Long	getQuantity()	Number of Product Variants 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.
MyLineItemDraftBuilder	key(String key)	User-defined unique identifier of the LineItem.
static MyLineItemDraftBuilder	of()	factory method for an instance of MyLineItemDraftBuilder
static MyLineItemDraftBuilder	of(MyLineItemDraft template)	create builder for MyLineItemDraft instance
MyLineItemDraftBuilder	productId(String productId)	id of the Product.
MyLineItemDraftBuilder	quantity(Long quantity)	Number of Product Variants to add to the Cart.
MyLineItemDraftBuilder	shippingDetails(ItemShippingDetailsDraft shippingDetails)	Container for Line Item-specific addresses.
MyLineItemDraftBuilder	shippingDetails(Function<ItemShippingDetailsDraftBuilder,ItemShippingDetailsDraftBuilder> builder)	Container for Line Item-specific addresses.
MyLineItemDraftBuilder	sku(String sku)	sku of the ProductVariant.
MyLineItemDraftBuilder	supplyChannel(ChannelResourceIdentifier supplyChannel)	Used to identify Inventory entries that must be reserved.
MyLineItemDraftBuilder	supplyChannel(Function<ChannelResourceIdentifierBuilder,ChannelResourceIdentifierBuilder> builder)	Used to identify Inventory entries that must be reserved.
MyLineItemDraftBuilder	variantId(Long variantId)	id of the ProductVariant in the Product.
MyLineItemDraftBuilder	withCustom(Function<CustomFieldsDraftBuilder,CustomFieldsDraft> builder)	Custom Fields for the Cart.
MyLineItemDraftBuilder	withDistributionChannel(Function<ChannelResourceIdentifierBuilder,ChannelResourceIdentifier> builder)	Used to select a Product Price.
MyLineItemDraftBuilder	withShippingDetails(Function<ItemShippingDetailsDraftBuilder,ItemShippingDetailsDraft> builder)	Container for Line Item-specific addresses.
MyLineItemDraftBuilder	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

MyLineItemDraftBuilder

public MyLineItemDraftBuilder()

Method Details

key

public MyLineItemDraftBuilder key(@Nullable
 String key)

User-defined unique identifier of the LineItem.

Parameters:

key - value to be set

Returns:

Builder

productId

public MyLineItemDraftBuilder productId(@Nullable
 String productId)

id of the Product.

Parameters:

productId - value to be set

Returns:

Builder

variantId

public MyLineItemDraftBuilder 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 MyLineItemDraftBuilder sku(@Nullable
 String sku)

sku of the ProductVariant.

Parameters:

sku - value to be set

Returns:

Builder

quantity

public MyLineItemDraftBuilder quantity(@Nullable
 Long quantity)

Number of Product Variants to add to the Cart.

Parameters:

quantity - value to be set

Returns:

Builder

addedAt

public MyLineItemDraftBuilder 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

supplyChannel

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

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

Parameters:

builder - function to build the supplyChannel value

Returns:

Builder

withSupplyChannel

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

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

Parameters:

builder - function to build the supplyChannel value

Returns:

Builder

supplyChannel

public MyLineItemDraftBuilder supplyChannel(@Nullable
 ChannelResourceIdentifier supplyChannel)

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

Parameters:

supplyChannel - value to be set

Returns:

Builder

distributionChannel

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

Used to select a Product Price. The 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 MyLineItemDraftBuilder withDistributionChannel(Function<ChannelResourceIdentifierBuilder,ChannelResourceIdentifier> builder)

Used to select a Product Price. The 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 MyLineItemDraftBuilder distributionChannel(@Nullable
 ChannelResourceIdentifier distributionChannel)

Used to select a Product Price. The 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

shippingDetails

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

Container for Line Item-specific addresses.

Parameters:

builder - function to build the shippingDetails value

Returns:

Builder

withShippingDetails

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

Container for Line Item-specific addresses.

Parameters:

builder - function to build the shippingDetails value

Returns:

Builder

shippingDetails

public MyLineItemDraftBuilder shippingDetails(@Nullable
 ItemShippingDetailsDraft shippingDetails)

Container for Line Item-specific addresses.

Parameters:

shippingDetails - value to be set

Returns:

Builder

custom

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

Custom Fields for the Cart.

Parameters:

builder - function to build the custom value

Returns:

Builder

withCustom

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

Custom Fields for the Cart.

Parameters:

builder - function to build the custom value

Returns:

Builder

custom

public MyLineItemDraftBuilder custom(@Nullable
 CustomFieldsDraft custom)

Custom Fields for the Cart.

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 the 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()

Number of Product Variants 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

getSupplyChannel

@Nullable
public ChannelResourceIdentifier getSupplyChannel()

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

Returns:

supplyChannel

getDistributionChannel

@Nullable
public ChannelResourceIdentifier getDistributionChannel()

Used to select a Product Price. The 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

getShippingDetails

@Nullable
public ItemShippingDetailsDraft getShippingDetails()

Container for Line Item-specific addresses.

Returns:

shippingDetails

getCustom

@Nullable
public CustomFieldsDraft getCustom()

Custom Fields for the Cart.

Returns:

custom

build

public MyLineItemDraft build()

builds MyLineItemDraft with checking for non-null required values

Specified by:

build in interface Builder<MyLineItemDraft>

Returns:

MyLineItemDraft

buildUnchecked

public MyLineItemDraft buildUnchecked()

builds MyLineItemDraft without checking for non-null required values

Returns:

MyLineItemDraft

of

public static MyLineItemDraftBuilder of()

factory method for an instance of MyLineItemDraftBuilder

Returns:

builder

of

public static MyLineItemDraftBuilder of(MyLineItemDraft template)

create builder for MyLineItemDraft instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder