Package com.commercetools.api.models.shopping_list

Interface ShoppingListLineItemDraft

All Superinterfaces:

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

All Known Implementing Classes:

ShoppingListLineItemDraftImpl

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

The ProductVariant to be included in the ShoppingListLineItem must be specified using the productID and variantID, or by the sku.

Example to create an instance using the builder pattern

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

Method Summary

Modifier and Type	Method	Description
static ShoppingListLineItemDraftBuilder	builder()	builder factory method for ShoppingListLineItemDraft
static ShoppingListLineItemDraftBuilder	builder(ShoppingListLineItemDraft template)	create builder for ShoppingListLineItemDraft instance
static ShoppingListLineItemDraft	deepCopy(ShoppingListLineItemDraft template)	factory method to create a deep copy of ShoppingListLineItemDraft
ZonedDateTime	getAddedAt()	Date and time the ShoppingListLineItem is added to the ShoppingList.
@Valid CustomFieldsDraft	getCustom()	Custom Fields 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.
static ShoppingListLineItemDraft	of()	factory method
static ShoppingListLineItemDraft	of(ShoppingListLineItemDraft template)	factory method to create a shallow copy ShoppingListLineItemDraft
void	setAddedAt(ZonedDateTime addedAt)	Date and time the ShoppingListLineItem is added to the ShoppingList.
void	setCustom(CustomFieldsDraft custom)	Custom Fields of the ShoppingListLineItem.
void	setProductId(String productId)	Unique identifier of a Product.
void	setQuantity(Long quantity)	Number of Products in the ShoppingListLineItem.
void	setSku(String sku)	sku of the ProductVariant.
void	setVariantId(Long variantId)	id of the ProductVariant.
static com.fasterxml.jackson.core.type.TypeReference<ShoppingListLineItemDraft>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withShoppingListLineItemDraft(Function<ShoppingListLineItemDraft,T> helper)	accessor map function

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

unwrapCustomizableDraft

Method Details

getProductId

String getProductId()

Unique identifier of a Product.

Returns:

productId

getVariantId

Long getVariantId()

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

Returns:

variantId

getSku

String getSku()

sku of the ProductVariant.

Returns:

sku

getAddedAt

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

@Valid
@Valid CustomFieldsDraft getCustom()

Custom Fields of the ShoppingListLineItem.

Specified by:

getCustom in interface CustomizableDraft<ShoppingListLineItemDraft>

Returns:

custom

getQuantity

Long getQuantity()

Number of Products in the ShoppingListLineItem.

Returns:

quantity

setProductId

void setProductId(String productId)

Unique identifier of a Product.

Parameters:

productId - value to be set

setVariantId

void setVariantId(Long variantId)

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

Parameters:

variantId - value to be set

setSku

void setSku(String sku)

sku of the ProductVariant.

Parameters:

sku - value to be set

setAddedAt

void setAddedAt(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

setCustom

void setCustom(CustomFieldsDraft custom)

Custom Fields of the ShoppingListLineItem.

Specified by:

setCustom in interface CustomizableDraft<ShoppingListLineItemDraft>

Parameters:

custom - value to be set

setQuantity

void setQuantity(Long quantity)

Number of Products in the ShoppingListLineItem.

Parameters:

quantity - value to be set

of

static ShoppingListLineItemDraft of()

factory method

Returns:

instance of ShoppingListLineItemDraft

of

static ShoppingListLineItemDraft of(ShoppingListLineItemDraft template)

factory method to create a shallow copy ShoppingListLineItemDraft

Parameters:

template - instance to be copied

Returns:

copy instance

deepCopy

@Nullable
static ShoppingListLineItemDraft deepCopy(@Nullable
 ShoppingListLineItemDraft template)

factory method to create a deep copy of ShoppingListLineItemDraft

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static ShoppingListLineItemDraftBuilder builder()

builder factory method for ShoppingListLineItemDraft

Returns:

builder

builder

static ShoppingListLineItemDraftBuilder builder(ShoppingListLineItemDraft template)

create builder for ShoppingListLineItemDraft instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withShoppingListLineItemDraft

default <T> T withShoppingListLineItemDraft(Function<ShoppingListLineItemDraft,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<ShoppingListLineItemDraft> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference