io.sphere.sdk.carts.commands

Interface CartDeleteCommand

All Superinterfaces:

Command<Cart>, DeleteCommand<Cart>, ExpansionPathContainer<Cart>, MetaModelReferenceExpansionDsl<Cart,CartDeleteCommand,CartExpansionModel<Cart>>, ReferenceExpansionDsl<Cart,CartDeleteCommand>, ReferenceExpansionSupport<Cart>, SphereRequest<Cart>

public interface CartDeleteCommand
extends MetaModelReferenceExpansionDsl<Cart,CartDeleteCommand,CartExpansionModel<Cart>>, DeleteCommand<Cart>

Deletes a cart

final CartDraft cartDraft = CartDraftBuilder.of(EUR).country(DE).build();
final Cart cart = client().executeBlocking(CartCreateCommand.of(cartDraft));
final String key = randomKey();
final Cart updatedCart = client().executeBlocking(CartUpdateCommand.of(cart, SetKey.of(key)));
assertThat(updatedCart.getKey()).isEqualTo(key);

client().executeBlocking(CartDeleteCommand.ofKey(key, updatedCart.getVersion()));

final PagedQueryResult<Cart> queryResult = client().executeBlocking(CartQuery.of().withPredicates(cartQueryModel -> cartQueryModel.key().is(updatedCart.getKey())));
assertThat(queryResult.getResults()).isEmpty();
See the test code.

See Also:

Cart

Method Summary

Modifier and Type	Method and Description
static CartDeleteCommand	of(Versioned<Cart> versioned) Creates a command object to delete a Cart by ID.
static CartDeleteCommand	of(Versioned<Cart> versioned, boolean eraseData) Creates a command object to delete a Cart by ID.
static CartDeleteCommand	ofId(String id, Long version) Creates a command object to delete a Cart by its id.
static CartDeleteCommand	ofId(String id, Long version, boolean eraseData) Creates a command object to delete a Cart by its id.
static CartDeleteCommand	ofKey(String key, Long version) Creates a command object to delete a Cart by its key.
static CartDeleteCommand	ofKey(String key, Long version, boolean eraseData) Creates a command object to delete a Cart by its key.

Methods inherited from interface io.sphere.sdk.expansion.MetaModelReferenceExpansionDsl

plusExpansionPaths, withExpansionPaths

Methods inherited from interface io.sphere.sdk.expansion.ReferenceExpansionDsl

plusExpansionPaths, plusExpansionPaths, plusExpansionPaths, plusExpansionPaths, withExpansionPaths, withExpansionPaths, withExpansionPaths, withExpansionPaths

Methods inherited from interface io.sphere.sdk.expansion.ReferenceExpansionSupport

expansionPaths

Methods inherited from interface io.sphere.sdk.client.SphereRequest

canDeserialize, deserialize, httpRequestIntent

Method Detail

of

static CartDeleteCommand of(Versioned<Cart> versioned)

Creates a command object to delete a Cart by ID.

Parameters:

versioned - the object to delete (so directly a Cart) or just the version/ID information of it

Returns:

delete command

of

static CartDeleteCommand of(Versioned<Cart> versioned,
                            boolean eraseData)

Creates a command object to delete a Cart by ID.

Parameters:

versioned - the object to delete (so directly a Cart) or just the version/ID information of it

eraseData - If set to true, Composable Commerce guarantees that all personal data related to the particular object, including invisible data, is erased, in compliance with the GDPR.

Returns:

delete command

ofKey

static CartDeleteCommand ofKey(String key,
                               Long version)

Creates a command object to delete a Cart by its key.

Parameters:

key - the key of the Cart to delete, see Cart.getKey()

version - `the current version of the Cart, see Resource.getVersion()

Returns:

delete command

ofKey

static CartDeleteCommand ofKey(String key,
                               Long version,
                               boolean eraseData)

Creates a command object to delete a Cart by its key.

Parameters:

key - the key of the Cart to delete, see Cart.getKey()

version - the current version of the Cart, see Resource.getVersion()

eraseData - If set to true, Composable Commerce guarantees that all personal data related to the particular object, including invisible data, is erased, in compliance with the GDPR.

Returns:

delete command

ofId

static CartDeleteCommand ofId(String id,
                              Long version)

Creates a command object to delete a Cart by its id.

Parameters:

id - the id of the Cart to delete, see Resource.getId()

version - `the current version of the Cart, see Resource.getVersion()

Returns:

delete command

ofId

static CartDeleteCommand ofId(String id,
                              Long version,
                              boolean eraseData)

Creates a command object to delete a Cart by its id.

Parameters:

id - the id of the Cart to delete, see Resource.getId()

version - the current version of the Cart, see Resource.getVersion()

eraseData - If set to true, Composable Commerce guarantees that all personal data related to the particular object, including invisible data, is erased, in compliance with the GDPR.

Returns:

delete command