Package com.commercetools.api.models.me

Class MyCartAddLineItemActionBuilder

java.lang.Object

com.commercetools.api.models.me.MyCartAddLineItemActionBuilder

All Implemented Interfaces:

Builder<MyCartAddLineItemAction>

public class MyCartAddLineItemActionBuilder
extends Object
implements Builder<MyCartAddLineItemAction>

MyCartAddLineItemActionBuilder Example to create an instance using the builder pattern

     MyCartAddLineItemAction myCartAddLineItemAction = MyCartAddLineItemAction.builder()
             .build()
 

Constructor Summary

Constructors

Constructor	Description
MyCartAddLineItemActionBuilder()

Method Summary

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

MyCartAddLineItemActionBuilder

public MyCartAddLineItemActionBuilder()

Method Details

key

public MyCartAddLineItemActionBuilder key(@Nullable
 String key)

User-defined unique identifier of the LineItem.

Parameters:

key - value to be set

Returns:

Builder

productId

public MyCartAddLineItemActionBuilder productId(@Nullable
 String productId)

id of the Product.

Either the productId and variantId, or sku must be provided.

Parameters:

productId - value to be set

Returns:

Builder

variantId

public MyCartAddLineItemActionBuilder variantId(@Nullable
 Long variantId)

id of the ProductVariant in the Product.

If not given, the Master Variant is used.

Either the productId and variantId, or sku must be provided.

Parameters:

variantId - value to be set

Returns:

Builder

sku

public MyCartAddLineItemActionBuilder sku(@Nullable
 String sku)

sku of the ProductVariant.

Either the productId and variantId, or sku must be provided.

Parameters:

sku - value to be set

Returns:

Builder

quantity

public MyCartAddLineItemActionBuilder quantity(@Nullable
 Long quantity)

Number of Line Items to add to the Cart.

Parameters:

quantity - value to be set

Returns:

Builder

addedAt

public MyCartAddLineItemActionBuilder addedAt(@Nullable
 ZonedDateTime addedAt)

Date and time (UTC) the Line Item was 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 MyCartAddLineItemActionBuilder 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 MyCartAddLineItemActionBuilder 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 MyCartAddLineItemActionBuilder 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

supplyChannel

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

shippingDetails

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

Container for Line Item-specific addresses.

Parameters:

builder - function to build the shippingDetails value

Returns:

Builder

withShippingDetails

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

Container for Line Item-specific addresses.

Parameters:

builder - function to build the shippingDetails value

Returns:

Builder

shippingDetails

public MyCartAddLineItemActionBuilder shippingDetails(@Nullable
 ItemShippingDetailsDraft shippingDetails)

Container for Line Item-specific addresses.

Parameters:

shippingDetails - value to be set

Returns:

Builder

custom

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

Custom Fields for the Line Item.

Parameters:

builder - function to build the custom value

Returns:

Builder

withCustom

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

Custom Fields for the Line Item.

Parameters:

builder - function to build the custom value

Returns:

Builder

custom

public MyCartAddLineItemActionBuilder 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 the Product.

Either the productId and variantId, or sku must be provided.

Returns:

productId

getVariantId

@Nullable
public Long getVariantId()

id of the ProductVariant in the Product.

If not given, the Master Variant is used.

Either the productId and variantId, or sku must be provided.

Returns:

variantId

getSku

@Nullable
public String getSku()

sku of the ProductVariant.

Either the productId and variantId, or sku must be provided.

Returns:

sku

getQuantity

@Nullable
public Long getQuantity()

Number of Line Items to add to the Cart.

Returns:

quantity

getAddedAt

@Nullable
public ZonedDateTime getAddedAt()

Date and time (UTC) the Line Item was 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 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 Channel must have the InventorySupply ChannelRoleEnum.

Returns:

supplyChannel

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 MyCartAddLineItemAction build()

builds MyCartAddLineItemAction with checking for non-null required values

Specified by:

build in interface Builder<MyCartAddLineItemAction>

Returns:

MyCartAddLineItemAction

buildUnchecked

public MyCartAddLineItemAction buildUnchecked()

builds MyCartAddLineItemAction without checking for non-null required values

Returns:

MyCartAddLineItemAction

of

public static MyCartAddLineItemActionBuilder of()

factory method for an instance of MyCartAddLineItemActionBuilder

Returns:

builder

of

public static MyCartAddLineItemActionBuilder of(MyCartAddLineItemAction template)

create builder for MyCartAddLineItemAction instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder