Package com.commercetools.api.models.cart

Interface CartChangeCustomLineItemQuantityAction

All Superinterfaces:

CartUpdateAction, ResourceUpdateAction<CartUpdateAction>

All Known Implementing Classes:

CartChangeCustomLineItemQuantityActionImpl

public interface CartChangeCustomLineItemQuantityAction
extends CartUpdateAction

When multiple shipping addresses are set for a Custom Line Item, use the Add CustomLineItem update action to change the shipping details. Since it is not possible for the API to infer how the overall change in the Custom Line Item quantity should be distributed over the sub-quantities, the shippingDetails field is kept in its current state to avoid data loss.

To change the Custom Line Item quantity and shipping details together, use this update action in combination with the Set CustomLineItemShippingDetails update action in a single Cart update command.

Example to create an instance using the builder pattern

     CartChangeCustomLineItemQuantityAction cartChangeCustomLineItemQuantityAction = CartChangeCustomLineItemQuantityAction.builder()
             .customLineItemId("{customLineItemId}")
             .quantity(0.3)
             .build()
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CHANGE_CUSTOM_LINE_ITEM_QUANTITY	discriminator value for CartChangeCustomLineItemQuantityAction

Method Summary

Modifier and Type	Method	Description
static CartChangeCustomLineItemQuantityActionBuilder	builder()	builder factory method for CartChangeCustomLineItemQuantityAction
static CartChangeCustomLineItemQuantityActionBuilder	builder(CartChangeCustomLineItemQuantityAction template)	create builder for CartChangeCustomLineItemQuantityAction instance
static CartChangeCustomLineItemQuantityAction	deepCopy(CartChangeCustomLineItemQuantityAction template)	factory method to create a deep copy of CartChangeCustomLineItemQuantityAction
@NotNull String	getCustomLineItemId()	id of the CustomLineItem to update.
@NotNull Long	getQuantity()	New value to set.
static CartChangeCustomLineItemQuantityAction	of()	factory method
static CartChangeCustomLineItemQuantityAction	of(CartChangeCustomLineItemQuantityAction template)	factory method to create a shallow copy CartChangeCustomLineItemQuantityAction
void	setCustomLineItemId(String customLineItemId)	id of the CustomLineItem to update.
void	setQuantity(Long quantity)	New value to set.
static com.fasterxml.jackson.core.type.TypeReference<CartChangeCustomLineItemQuantityAction>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withCartChangeCustomLineItemQuantityAction(Function<CartChangeCustomLineItemQuantityAction,T> helper)	accessor map function

Methods inherited from interface com.commercetools.api.models.cart.CartUpdateAction

getAction, withCartUpdateAction

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

get

Field Details

CHANGE_CUSTOM_LINE_ITEM_QUANTITY

static final String CHANGE_CUSTOM_LINE_ITEM_QUANTITY

discriminator value for CartChangeCustomLineItemQuantityAction

See Also:

• Constant Field Values

Method Details

getCustomLineItemId

@NotNull
@NotNull String getCustomLineItemId()

id of the CustomLineItem to update.

Returns:

customLineItemId

getQuantity

@NotNull
@NotNull Long getQuantity()

New value to set.

If 0, the Custom Line Item is removed from the Cart.

Returns:

quantity

setCustomLineItemId

void setCustomLineItemId(String customLineItemId)

id of the CustomLineItem to update.

Parameters:

customLineItemId - value to be set

setQuantity

void setQuantity(Long quantity)

New value to set.

If 0, the Custom Line Item is removed from the Cart.

Parameters:

quantity - value to be set

of

static CartChangeCustomLineItemQuantityAction of()

factory method

Returns:

instance of CartChangeCustomLineItemQuantityAction

of

static CartChangeCustomLineItemQuantityAction of(CartChangeCustomLineItemQuantityAction template)

factory method to create a shallow copy CartChangeCustomLineItemQuantityAction

Parameters:

template - instance to be copied

Returns:

copy instance

deepCopy

@Nullable
static CartChangeCustomLineItemQuantityAction deepCopy(@Nullable
 CartChangeCustomLineItemQuantityAction template)

factory method to create a deep copy of CartChangeCustomLineItemQuantityAction

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static CartChangeCustomLineItemQuantityActionBuilder builder()

builder factory method for CartChangeCustomLineItemQuantityAction

Returns:

builder

builder

static CartChangeCustomLineItemQuantityActionBuilder builder(CartChangeCustomLineItemQuantityAction template)

create builder for CartChangeCustomLineItemQuantityAction instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withCartChangeCustomLineItemQuantityAction

default <T> T withCartChangeCustomLineItemQuantityAction(Function<CartChangeCustomLineItemQuantityAction,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<CartChangeCustomLineItemQuantityAction> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference