Package com.commercetools.api.models.cart

Interface CartRemoveCustomLineItemAction

All Superinterfaces:

CartUpdateAction, ResourceUpdateAction<CartUpdateAction>

All Known Implementing Classes:

CartRemoveCustomLineItemActionImpl

public interface CartRemoveCustomLineItemAction
extends CartUpdateAction

This update action does not support specifying quantities, unlike the Remove LineItem update action.

If shippingDetails must be partially removed, use the Change CustomLineItem Quantity update action.

Example to create an instance using the builder pattern

     CartRemoveCustomLineItemAction cartRemoveCustomLineItemAction = CartRemoveCustomLineItemAction.builder()
             .build()
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	REMOVE_CUSTOM_LINE_ITEM	discriminator value for CartRemoveCustomLineItemAction

Method Summary

Modifier and Type	Method	Description
static CartRemoveCustomLineItemActionBuilder	builder()	builder factory method for CartRemoveCustomLineItemAction
static CartRemoveCustomLineItemActionBuilder	builder(CartRemoveCustomLineItemAction template)	create builder for CartRemoveCustomLineItemAction instance
static CartRemoveCustomLineItemAction	deepCopy(CartRemoveCustomLineItemAction template)	factory method to create a deep copy of CartRemoveCustomLineItemAction
String	getCustomLineItemId()	id of the CustomLineItem to update.
String	getCustomLineItemKey()	key of the CustomLineItem to update.
static CartRemoveCustomLineItemAction	of()	factory method
static CartRemoveCustomLineItemAction	of(CartRemoveCustomLineItemAction template)	factory method to create a shallow copy CartRemoveCustomLineItemAction
void	setCustomLineItemId(String customLineItemId)	id of the CustomLineItem to update.
void	setCustomLineItemKey(String customLineItemKey)	key of the CustomLineItem to update.
static com.fasterxml.jackson.core.type.TypeReference<CartRemoveCustomLineItemAction>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withCartRemoveCustomLineItemAction(Function<CartRemoveCustomLineItemAction,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

REMOVE_CUSTOM_LINE_ITEM

static final String REMOVE_CUSTOM_LINE_ITEM

discriminator value for CartRemoveCustomLineItemAction

See Also:

• Constant Field Values

Method Details

getCustomLineItemId

String getCustomLineItemId()

id of the CustomLineItem to update. Either customLineItemId or customLineItemKey is required.

Returns:

customLineItemId

getCustomLineItemKey

String getCustomLineItemKey()

key of the CustomLineItem to update. Either customLineItemId or customLineItemKey is required.

Returns:

customLineItemKey

setCustomLineItemId

void setCustomLineItemId(String customLineItemId)

id of the CustomLineItem to update. Either customLineItemId or customLineItemKey is required.

Parameters:

customLineItemId - value to be set

setCustomLineItemKey

void setCustomLineItemKey(String customLineItemKey)

key of the CustomLineItem to update. Either customLineItemId or customLineItemKey is required.

Parameters:

customLineItemKey - value to be set

of

static CartRemoveCustomLineItemAction of()

factory method

Returns:

instance of CartRemoveCustomLineItemAction

of

static CartRemoveCustomLineItemAction of(CartRemoveCustomLineItemAction template)

factory method to create a shallow copy CartRemoveCustomLineItemAction

Parameters:

template - instance to be copied

Returns:

copy instance

deepCopy

@Nullable
static CartRemoveCustomLineItemAction deepCopy(@Nullable
 CartRemoveCustomLineItemAction template)

factory method to create a deep copy of CartRemoveCustomLineItemAction

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static CartRemoveCustomLineItemActionBuilder builder()

builder factory method for CartRemoveCustomLineItemAction

Returns:

builder

builder

static CartRemoveCustomLineItemActionBuilder builder(CartRemoveCustomLineItemAction template)

create builder for CartRemoveCustomLineItemAction instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withCartRemoveCustomLineItemAction

default <T> T withCartRemoveCustomLineItemAction(Function<CartRemoveCustomLineItemAction,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<CartRemoveCustomLineItemAction> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference