Package com.commercetools.api.models.me

Interface MyCartRemoveLineItemAction

All Superinterfaces:

MyCartUpdateAction, ResourceUpdateAction<MyCartUpdateAction>

All Known Implementing Classes:

MyCartRemoveLineItemActionImpl

public interface MyCartRemoveLineItemAction
extends MyCartUpdateAction

The LineItem price is updated as described in LineItem Price selection.

Example to create an instance using the builder pattern

     MyCartRemoveLineItemAction myCartRemoveLineItemAction = MyCartRemoveLineItemAction.builder()
             .lineItemId("{lineItemId}")
             .build()
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	REMOVE_LINE_ITEM	discriminator value for MyCartRemoveLineItemAction

Method Summary

Modifier and Type	Method	Description
static MyCartRemoveLineItemActionBuilder	builder()	builder factory method for MyCartRemoveLineItemAction
static MyCartRemoveLineItemActionBuilder	builder(MyCartRemoveLineItemAction template)	create builder for MyCartRemoveLineItemAction instance
static MyCartRemoveLineItemAction	deepCopy(MyCartRemoveLineItemAction template)	factory method to create a deep copy of MyCartRemoveLineItemAction
@Valid Money	getExternalPrice()	Sets the LineItem price to the given value when decreasing the quantity of a Line Item with the ExternalPrice LineItemPriceMode.
@Valid ExternalLineItemTotalPrice	getExternalTotalPrice()	Sets the LineItem price and totalPrice to the given value when decreasing the quantity of a Line Item with the ExternalTotal LineItemPriceMode.
@NotNull String	getLineItemId()	id of the Line Item to remove.
Long	getQuantity()	New value to set.
@Valid ItemShippingDetailsDraft	getShippingDetailsToRemove()	Container for Line Item-specific addresses to remove.
static MyCartRemoveLineItemAction	of()	factory method
static MyCartRemoveLineItemAction	of(MyCartRemoveLineItemAction template)	factory method to create a shallow copy MyCartRemoveLineItemAction
void	setExternalPrice(Money externalPrice)	Sets the LineItem price to the given value when decreasing the quantity of a Line Item with the ExternalPrice LineItemPriceMode.
void	setExternalTotalPrice(ExternalLineItemTotalPrice externalTotalPrice)	Sets the LineItem price and totalPrice to the given value when decreasing the quantity of a Line Item with the ExternalTotal LineItemPriceMode.
void	setLineItemId(String lineItemId)	id of the Line Item to remove.
void	setQuantity(Long quantity)	New value to set.
void	setShippingDetailsToRemove(ItemShippingDetailsDraft shippingDetailsToRemove)	Container for Line Item-specific addresses to remove.
static com.fasterxml.jackson.core.type.TypeReference<MyCartRemoveLineItemAction>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withMyCartRemoveLineItemAction(Function<MyCartRemoveLineItemAction,T> helper)	accessor map function

Methods inherited from interface com.commercetools.api.models.me.MyCartUpdateAction

getAction, withMyCartUpdateAction

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

get

Field Details

REMOVE_LINE_ITEM

static final String REMOVE_LINE_ITEM

discriminator value for MyCartRemoveLineItemAction

See Also:

• Constant Field Values

Method Details

getLineItemId

@NotNull
@NotNull String getLineItemId()

id of the Line Item to remove.

Returns:

lineItemId

getQuantity

Long getQuantity()

New value to set.

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

Returns:

quantity

getExternalPrice

@Valid
@Valid Money getExternalPrice()

Sets the LineItem price to the given value when decreasing the quantity of a Line Item with the ExternalPrice LineItemPriceMode.

Returns:

externalPrice

getExternalTotalPrice

@Valid
@Valid ExternalLineItemTotalPrice getExternalTotalPrice()

Sets the LineItem price and totalPrice to the given value when decreasing the quantity of a Line Item with the ExternalTotal LineItemPriceMode.

Returns:

externalTotalPrice

getShippingDetailsToRemove

@Valid
@Valid ItemShippingDetailsDraft getShippingDetailsToRemove()

Container for Line Item-specific addresses to remove.

Returns:

shippingDetailsToRemove

setLineItemId

void setLineItemId(String lineItemId)

id of the Line Item to remove.

Parameters:

lineItemId - value to be set

setQuantity

void setQuantity(Long quantity)

New value to set.

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

Parameters:

quantity - value to be set

setExternalPrice

void setExternalPrice(Money externalPrice)

Sets the LineItem price to the given value when decreasing the quantity of a Line Item with the ExternalPrice LineItemPriceMode.

Parameters:

externalPrice - value to be set

setExternalTotalPrice

void setExternalTotalPrice(ExternalLineItemTotalPrice externalTotalPrice)

Sets the LineItem price and totalPrice to the given value when decreasing the quantity of a Line Item with the ExternalTotal LineItemPriceMode.

Parameters:

externalTotalPrice - value to be set

setShippingDetailsToRemove

void setShippingDetailsToRemove(ItemShippingDetailsDraft shippingDetailsToRemove)

Container for Line Item-specific addresses to remove.

Parameters:

shippingDetailsToRemove - value to be set

of

static MyCartRemoveLineItemAction of()

factory method

Returns:

instance of MyCartRemoveLineItemAction

of

static MyCartRemoveLineItemAction of(MyCartRemoveLineItemAction template)

factory method to create a shallow copy MyCartRemoveLineItemAction

Parameters:

template - instance to be copied

Returns:

copy instance

deepCopy

@Nullable
static MyCartRemoveLineItemAction deepCopy(@Nullable
 MyCartRemoveLineItemAction template)

factory method to create a deep copy of MyCartRemoveLineItemAction

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static MyCartRemoveLineItemActionBuilder builder()

builder factory method for MyCartRemoveLineItemAction

Returns:

builder

builder

static MyCartRemoveLineItemActionBuilder builder(MyCartRemoveLineItemAction template)

create builder for MyCartRemoveLineItemAction instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withMyCartRemoveLineItemAction

default <T> T withMyCartRemoveLineItemAction(Function<MyCartRemoveLineItemAction,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<MyCartRemoveLineItemAction> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference