io.sphere.sdk.carts.commands.updateactions

Class RemoveLineItem

java.lang.Object

io.sphere.sdk.models.Base

io.sphere.sdk.commands.UpdateActionImpl<Cart>

io.sphere.sdk.carts.commands.updateactions.RemoveLineItem

All Implemented Interfaces:

UpdateAction<Cart>

public final class RemoveLineItem
extends UpdateActionImpl<Cart>

Decreases the quantity of the given line item. If after the update the quantity of the line item is not greater than 0 or the quantity is not specified, the line item is removed from the cart.

See also CartInStoreUpdateCommand.

withEmptyCartAndProduct(client(), (cart, product) -> {
    assertThat(cart.getLineItems()).hasSize(0);
    final AddLineItem action = AddLineItem.of(product.getId(), MASTER_VARIANT_ID, 3L);

    final Cart cartWith3 = client().executeBlocking(CartUpdateCommand.of(cart, action));
    final LineItem lineItem = cartWith3.getLineItems().get(0);
    assertThat(lineItem.getQuantity()).isEqualTo(3);

    final Cart cartWith2 = client().executeBlocking(CartUpdateCommand.of(cartWith3, RemoveLineItem.of(lineItem, 1L)));
    assertThat(cartWith2.getLineItems().get(0).getQuantity()).isEqualTo(2);

    final Cart cartWith0 = client().executeBlocking(CartUpdateCommand.of(cartWith2, RemoveLineItem.of(lineItem)));
    assertThat(cartWith0.getLineItems()).hasSize(0);
});
See the test code.

Method Summary

Modifier and Type	Method and Description
javax.money.MonetaryAmount	getExternalPrice()
ExternalLineItemTotalPrice	getExternalTotalPrice()
String	getLineItemId()
Long	getQuantity()
ItemShippingDetailsDraft	getShippingDetailsToRemove()
static RemoveLineItem	of(LineItem lineItem)
static RemoveLineItem	of(LineItem lineItem, Long quantity)
static RemoveLineItem	of(String lineItemId)
static RemoveLineItem	of(String lineItemId, Long quantity)
static RemoveLineItem	of(String lineItemId, Long quantity, javax.money.MonetaryAmount externalPrice, ExternalLineItemTotalPrice externalTotalPrice, ItemShippingDetailsDraft shippingDetailsToRemove) Creates a new object initialized with the given values.
static RemoveLineItem	ofLineItemAndExternalPrice(LineItem lineItem, Long quantity, javax.money.MonetaryAmount externalPrice)
static RemoveLineItem	ofLineItemAndExternalPrice(String lineItemId, Long quantity, javax.money.MonetaryAmount externalPrice)
static RemoveLineItem	ofLineItemAndExternalTotalPrice(LineItem lineItem, Long quantity, ExternalLineItemTotalPrice externalTotalPrice)
static RemoveLineItem	ofLineItemAndExternalTotalPrice(String lineItemId, Long quantity, ExternalLineItemTotalPrice externalTotalPrice)
RemoveLineItem	withExternalPrice(javax.money.MonetaryAmount externalPrice) Creates a copied update action initialized with the given parameter, the rest of the parameters are copied from the original object.
RemoveLineItem	withExternalTotalPrice(ExternalLineItemTotalPrice externalTotalPrice) Creates a copied update action initialized with the given parameter, the rest of the parameters are copied from the original object.
RemoveLineItem	withQuantity(Long quantity) Creates a copied update action initialized with the given parameter, the rest of the parameters are copied from the original object.
RemoveLineItem	withShippingDetailsToRemove(ItemShippingDetailsDraft shippingDetailsToRemove) Creates a copied update action initialized with the given parameter, the rest of the parameters are copied from the original object.

Methods inherited from class io.sphere.sdk.commands.UpdateActionImpl

getAction

Methods inherited from class io.sphere.sdk.models.Base

equals, hashCode, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

of

public static RemoveLineItem of(String lineItemId,
                                @Nullable
                                Long quantity)

of

public static RemoveLineItem of(String lineItemId)

of

public static RemoveLineItem of(LineItem lineItem,
                                @Nullable
                                Long quantity)

of

public static RemoveLineItem of(LineItem lineItem)

ofLineItemAndExternalPrice

public static RemoveLineItem ofLineItemAndExternalPrice(LineItem lineItem,
                                                        @Nullable
                                                        Long quantity,
                                                        @Nullable
                                                        javax.money.MonetaryAmount externalPrice)

ofLineItemAndExternalPrice

public static RemoveLineItem ofLineItemAndExternalPrice(String lineItemId,
                                                        @Nullable
                                                        Long quantity,
                                                        @Nullable
                                                        javax.money.MonetaryAmount externalPrice)

ofLineItemAndExternalTotalPrice

public static RemoveLineItem ofLineItemAndExternalTotalPrice(LineItem lineItem,
                                                             @Nullable
                                                             Long quantity,
                                                             @Nullable
                                                             ExternalLineItemTotalPrice externalTotalPrice)

ofLineItemAndExternalTotalPrice

public static RemoveLineItem ofLineItemAndExternalTotalPrice(String lineItemId,
                                                             @Nullable
                                                             Long quantity,
                                                             @Nullable
                                                             ExternalLineItemTotalPrice externalTotalPrice)

getLineItemId

public String getLineItemId()

getQuantity

@Nullable
public Long getQuantity()

getExternalPrice

@Nullable
public javax.money.MonetaryAmount getExternalPrice()

getExternalTotalPrice

@Nullable
public ExternalLineItemTotalPrice getExternalTotalPrice()

getShippingDetailsToRemove

@Nullable
public ItemShippingDetailsDraft getShippingDetailsToRemove()

of

public static RemoveLineItem of(String lineItemId,
                                @Nullable
                                Long quantity,
                                @Nullable
                                javax.money.MonetaryAmount externalPrice,
                                @Nullable
                                ExternalLineItemTotalPrice externalTotalPrice,
                                @Nullable
                                ItemShippingDetailsDraft shippingDetailsToRemove)

Creates a new object initialized with the given values.

Parameters:

lineItemId - initial value for the property

quantity - initial value for the property

externalPrice - initial value for the property

externalTotalPrice - initial value for the property

shippingDetailsToRemove - initial value for the property

Returns:

new object initialized with the given values

withQuantity

public RemoveLineItem withQuantity(Long quantity)

Creates a copied update action initialized with the given parameter, the rest of the parameters are copied from the original object.

Returns:

new object initialized with the copied values from the original object

withExternalPrice

public RemoveLineItem withExternalPrice(javax.money.MonetaryAmount externalPrice)

Creates a copied update action initialized with the given parameter, the rest of the parameters are copied from the original object.

Returns:

new object initialized with the copied values from the original object

withExternalTotalPrice

public RemoveLineItem withExternalTotalPrice(ExternalLineItemTotalPrice externalTotalPrice)

Creates a copied update action initialized with the given parameter, the rest of the parameters are copied from the original object.

Returns:

new object initialized with the copied values from the original object

withShippingDetailsToRemove

public RemoveLineItem withShippingDetailsToRemove(ItemShippingDetailsDraft shippingDetailsToRemove)

Creates a copied update action initialized with the given parameter, the rest of the parameters are copied from the original object.

Returns:

new object initialized with the copied values from the original object