Package com.commercetools.api.models.shopping_list

Class ShoppingListLineItemDraftBuilder

java.lang.Object

com.commercetools.api.models.shopping_list.ShoppingListLineItemDraftBuilder

All Implemented Interfaces:

Builder<ShoppingListLineItemDraft>

public class ShoppingListLineItemDraftBuilder
extends Object
implements Builder<ShoppingListLineItemDraft>

ShoppingListLineItemDraftBuilder Example to create an instance using the builder pattern

     ShoppingListLineItemDraft shoppingListLineItemDraft = ShoppingListLineItemDraft.builder()
             .build()
 

Constructor Summary

Constructors

Constructor	Description
ShoppingListLineItemDraftBuilder()

Method Summary

Modifier and Type	Method	Description
ShoppingListLineItemDraftBuilder	addedAt(ZonedDateTime addedAt)	Date and time the ShoppingListLineItem is added to the ShoppingList.
ShoppingListLineItemDraft	build()	builds ShoppingListLineItemDraft with checking for non-null required values
ShoppingListLineItemDraft	buildUnchecked()	builds ShoppingListLineItemDraft without checking for non-null required values
ShoppingListLineItemDraftBuilder	custom(CustomFieldsDraft custom)	Custom Fields for the ShoppingListLineItem.
ShoppingListLineItemDraftBuilder	custom(Function<CustomFieldsDraftBuilder,CustomFieldsDraftBuilder> builder)	Custom Fields for the ShoppingListLineItem.
ZonedDateTime	getAddedAt()	Date and time the ShoppingListLineItem is added to the ShoppingList.
CustomFieldsDraft	getCustom()	Custom Fields for the ShoppingListLineItem.
String	getKey()	User-defined identifier of the ShoppingListLineItem.
String	getProductId()	Unique identifier of a Product.
Long	getQuantity()	Number of Products in the ShoppingListLineItem.
String	getSku()	sku of the ProductVariant.
Long	getVariantId()	id of the ProductVariant.
ShoppingListLineItemDraftBuilder	key(String key)	User-defined identifier of the ShoppingListLineItem.
static ShoppingListLineItemDraftBuilder	of()	factory method for an instance of ShoppingListLineItemDraftBuilder
static ShoppingListLineItemDraftBuilder	of(ShoppingListLineItemDraft template)	create builder for ShoppingListLineItemDraft instance
ShoppingListLineItemDraftBuilder	productId(String productId)	Unique identifier of a Product.
ShoppingListLineItemDraftBuilder	quantity(Long quantity)	Number of Products in the ShoppingListLineItem.
ShoppingListLineItemDraftBuilder	sku(String sku)	sku of the ProductVariant.
ShoppingListLineItemDraftBuilder	variantId(Long variantId)	id of the ProductVariant.
ShoppingListLineItemDraftBuilder	withCustom(Function<CustomFieldsDraftBuilder,CustomFieldsDraft> builder)	Custom Fields for the ShoppingListLineItem.

Methods inherited from class java.lang.Object

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

Constructor Details

ShoppingListLineItemDraftBuilder

public ShoppingListLineItemDraftBuilder()

Method Details

key

public ShoppingListLineItemDraftBuilder key(@Nullable
 String key)

User-defined identifier of the ShoppingListLineItem. Must be unique per ShoppingList.

Parameters:

key - value to be set

Returns:

Builder

productId

public ShoppingListLineItemDraftBuilder productId(@Nullable
 String productId)

Unique identifier of a Product.

Parameters:

productId - value to be set

Returns:

Builder

variantId

public ShoppingListLineItemDraftBuilder variantId(@Nullable
 Long variantId)

id of the ProductVariant. If not set, the ShoppingListLineItem refers to the Master Variant.

For a Project with ProductCatalogModel set to Modular, when variantId is not set, the ShoppingListLineItem refers to the Product's default Variant (defaultVariant) instead of the Master Variant. If no default Variant is set, the ShoppingListLineItem refers to the Variant with the lowest variantId.

Parameters:

variantId - value to be set

Returns:

Builder

sku

public ShoppingListLineItemDraftBuilder sku(@Nullable
 String sku)

sku of the ProductVariant.

Parameters:

sku - value to be set

Returns:

Builder

addedAt

public ShoppingListLineItemDraftBuilder addedAt(@Nullable
 ZonedDateTime addedAt)

Date and time the ShoppingListLineItem is added to the ShoppingList. If not set, the current date and time (UTC) is used.

Parameters:

addedAt - value to be set

Returns:

Builder

custom

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

Custom Fields for the ShoppingListLineItem.

Parameters:

builder - function to build the custom value

Returns:

Builder

withCustom

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

Custom Fields for the ShoppingListLineItem.

Parameters:

builder - function to build the custom value

Returns:

Builder

custom

public ShoppingListLineItemDraftBuilder custom(@Nullable
 CustomFieldsDraft custom)

Custom Fields for the ShoppingListLineItem.

Parameters:

custom - value to be set

Returns:

Builder

quantity

public ShoppingListLineItemDraftBuilder quantity(@Nullable
 Long quantity)

Number of Products in the ShoppingListLineItem.

Parameters:

quantity - value to be set

Returns:

Builder

getKey

@Nullable
public String getKey()

User-defined identifier of the ShoppingListLineItem. Must be unique per ShoppingList.

Returns:

key

getProductId

@Nullable
public String getProductId()

Unique identifier of a Product.

Returns:

productId

getVariantId

@Nullable
public Long getVariantId()

id of the ProductVariant. If not set, the ShoppingListLineItem refers to the Master Variant.

For a Project with ProductCatalogModel set to Modular, when variantId is not set, the ShoppingListLineItem refers to the Product's default Variant (defaultVariant) instead of the Master Variant. If no default Variant is set, the ShoppingListLineItem refers to the Variant with the lowest variantId.

Returns:

variantId

getSku

@Nullable
public String getSku()

sku of the ProductVariant.

Returns:

sku

getAddedAt

@Nullable
public ZonedDateTime getAddedAt()

Date and time the ShoppingListLineItem is added to the ShoppingList. If not set, the current date and time (UTC) is used.

Returns:

addedAt

getCustom

@Nullable
public CustomFieldsDraft getCustom()

Custom Fields for the ShoppingListLineItem.

Returns:

custom

getQuantity

@Nullable
public Long getQuantity()

Number of Products in the ShoppingListLineItem.

Returns:

quantity

build

public ShoppingListLineItemDraft build()

builds ShoppingListLineItemDraft with checking for non-null required values

Specified by:

build in interface Builder<ShoppingListLineItemDraft>

Returns:

ShoppingListLineItemDraft

buildUnchecked

public ShoppingListLineItemDraft buildUnchecked()

builds ShoppingListLineItemDraft without checking for non-null required values

Returns:

ShoppingListLineItemDraft

of

public static ShoppingListLineItemDraftBuilder of()

factory method for an instance of ShoppingListLineItemDraftBuilder

Returns:

builder

of

public static ShoppingListLineItemDraftBuilder of(ShoppingListLineItemDraft template)

create builder for ShoppingListLineItemDraft instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder