io.sphere.sdk.carts.commands.updateactions

Class AddCustomLineItem

java.lang.Object

io.sphere.sdk.models.Base

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

io.sphere.sdk.carts.commands.updateactions.AddCustomLineItem

All Implemented Interfaces:

UpdateAction<Cart>, CustomDraft

public final class AddCustomLineItem
extends UpdateActionImpl<Cart>
implements CustomDraft

Adds a CustomLineItem to the cart.

See also CartInStoreUpdateCommand.

Add a simple CustomLineItem:

withTaxCategory(client(), taxCategory -> {
    final Cart cart = createCartWithCountry(client());
    assertThat(cart.getCustomLineItems()).isEmpty();
    final MonetaryAmount money = MoneyImpl.of("23.50", EUR);
    final String slug = "thing-slug";//you handle to identify the custom line item
    final LocalizedString name = en("thing");
    final long quantity = 5;
    final CustomLineItemDraft item = CustomLineItemDraft.of(name, slug, money, taxCategory, quantity, null);

    final Cart cartWith5 = client().executeBlocking(CartUpdateCommand.of(cart, AddCustomLineItem.of(item)));
    assertThat(cartWith5.getCustomLineItems()).hasSize(1);
    final CustomLineItem customLineItem = cartWith5.getCustomLineItems().get(0);
    assertThat(customLineItem.getMoney()).isEqualTo(money);
    assertThat(customLineItem.getName()).isEqualTo(name);
    assertThat(customLineItem.getQuantity()).isEqualTo(quantity);
    assertThat(customLineItem.getSlug()).isEqualTo(slug);
    final Set<ItemState> state = customLineItem.getState();
    assertThat(state).hasSize(1);
    assertThat(state).extracting("quantity").containsOnly(quantity);
    assertThat(customLineItem.getTaxCategory()).isEqualTo(taxCategory.toReference());

    final CartQuery cartQuery = CartQuery.of()
            .withPredicates(m -> m.customLineItems().slug().is(customLineItem.getSlug())
                    .and(m.id().is(cart.getId())));
    assertThat(client().executeBlocking(cartQuery).head().get().getId()).isEqualTo(cart.getId());
});
See the test code.

Add a CustomLineItem with CustomFields:

withUpdateableType(client(), type -> {
    withCartAndTaxedProduct(client(), (cart, product) -> {
        final CustomFieldsDraft customFieldsDraft =
                CustomFieldsDraftBuilder
                        .ofType(type)
                        .addObject(STRING_FIELD_NAME, "a value")
                        .build();
        final AddCustomLineItem updateAction = AddCustomLineItem.of(en("custom line item"), "foo", EURO_30, product.getTaxCategory(), 3L).withCustom(customFieldsDraft);

        final Cart updatedCart = client().executeBlocking(CartUpdateCommand.of(cart, updateAction));

        final CustomFields customFields = updatedCart.getCustomLineItems().get(0).getCustom();
        assertThat(customFields.getFieldAsString(STRING_FIELD_NAME)).isEqualTo("a value");
        return updatedCart;
    });
    return type;
});
See the test code.

See Also:

Cart.getCustomLineItems(), RemoveCustomLineItem

Method Summary

Modifier and Type	Method and Description
CustomFieldsDraft	getCustom()
ExternalTaxRateDraft	getExternalTaxRate()
javax.money.MonetaryAmount	getMoney()
LocalizedString	getName()
Long	getQuantity()
String	getSlug()
ResourceIdentifier<TaxCategory>	getTaxCategory()
static AddCustomLineItem	of(CustomLineItemDraft draft)
static AddCustomLineItem	of(LocalizedString name, String slug, javax.money.MonetaryAmount money, Referenceable<TaxCategory> taxCategory, long quantity)
static AddCustomLineItem	of(LocalizedString name, String slug, javax.money.MonetaryAmount money, Referenceable<TaxCategory> taxCategory, long quantity, CustomFieldsDraft custom)
static AddCustomLineItem	of(LocalizedString name, String slug, javax.money.MonetaryAmount money, ResourceIdentifier<TaxCategory> taxCategory, long quantity, CustomFieldsDraft custom)
AddCustomLineItem	withCustom(CustomFieldsDraft custom)
AddCustomLineItem	withExternalTaxRate(ExternalTaxRateDraft externalTaxRate)

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 AddCustomLineItem of(LocalizedString name,
                                   String slug,
                                   javax.money.MonetaryAmount money,
                                   Referenceable<TaxCategory> taxCategory,
                                   long quantity)

of

public static AddCustomLineItem of(LocalizedString name,
                                   String slug,
                                   javax.money.MonetaryAmount money,
                                   Referenceable<TaxCategory> taxCategory,
                                   long quantity,
                                   @Nullable
                                   CustomFieldsDraft custom)

of

public static AddCustomLineItem of(LocalizedString name,
                                   String slug,
                                   javax.money.MonetaryAmount money,
                                   ResourceIdentifier<TaxCategory> taxCategory,
                                   long quantity,
                                   @Nullable
                                   CustomFieldsDraft custom)

of

public static AddCustomLineItem of(CustomLineItemDraft draft)

getName

public LocalizedString getName()

getQuantity

public Long getQuantity()

getMoney

public javax.money.MonetaryAmount getMoney()

getSlug

public String getSlug()

getTaxCategory

@Nullable
public ResourceIdentifier<TaxCategory> getTaxCategory()

getCustom

@Nullable
public CustomFieldsDraft getCustom()

Specified by:

getCustom in interface CustomDraft

getExternalTaxRate

@Nullable
public ExternalTaxRateDraft getExternalTaxRate()

withCustom

public AddCustomLineItem withCustom(@Nullable
                                    CustomFieldsDraft custom)

withExternalTaxRate

public AddCustomLineItem withExternalTaxRate(@Nullable
                                             ExternalTaxRateDraft externalTaxRate)