io.sphere.sdk.orders.commands

Interface OrderDeleteCommand

All Superinterfaces:

Command<Order>, DeleteCommand<Order>, ExpansionPathContainer<Order>, MetaModelReferenceExpansionDsl<Order,OrderDeleteCommand,OrderExpansionModel<Order>>, ReferenceExpansionDsl<Order,OrderDeleteCommand>, ReferenceExpansionSupport<Order>, SphereRequest<Order>

public interface OrderDeleteCommand
extends MetaModelReferenceExpansionDsl<Order,OrderDeleteCommand,OrderExpansionModel<Order>>, DeleteCommand<Order>

Command object to delete a Order.

withOrder(client(), order -> {
    final Order deletedOrder = client().executeBlocking(OrderDeleteCommand.of(order));
    final Order queriedDeletedOrder = client().executeBlocking(OrderByIdGet.of(deletedOrder));
    assertThat(queriedDeletedOrder).isNull();
});
See the test code.

withOrder(client(), order -> {
    final String orderNumber = randomString();
    final Order orderWithOrderNumber = client().executeBlocking(OrderUpdateCommand.of(order, SetOrderNumber.of(orderNumber)));

    final Order deletedOrder = client().executeBlocking(OrderDeleteCommand.ofOrderNumber(orderNumber, orderWithOrderNumber.getVersion()));
    final Order queriedDeletedOrder = client().executeBlocking(OrderByIdGet.of(deletedOrder));
    assertThat(queriedDeletedOrder).isNull();
});
See the test code.

See Also:

Order

Method Summary

Modifier and Type	Method and Description
static OrderDeleteCommand	of(Versioned<Order> versioned) Creates a command object to delete a Order by ID.
static OrderDeleteCommand	of(Versioned<Order> versioned, boolean eraseData) Creates a command object to delete a Order by ID.
static OrderDeleteCommand	ofOrderNumber(String orderNumber, Long version) Creates a command object to delete a Order by its orderNumber.
static OrderDeleteCommand	ofOrderNumber(String orderNumber, Long version, boolean eraseData) Creates a command object to delete a Order by its orderNumber.

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 OrderDeleteCommand of(Versioned<Order> versioned)

Creates a command object to delete a Order by ID.

Parameters:

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

Returns:

delete command

of

static OrderDeleteCommand of(Versioned<Order> versioned,
                             boolean eraseData)

Creates a command object to delete a Order by ID.

Parameters:

versioned - the object to delete (so directly a Order) 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

ofOrderNumber

static OrderDeleteCommand ofOrderNumber(String orderNumber,
                                        Long version)

Creates a command object to delete a Order by its orderNumber.

Parameters:

orderNumber - the orderNumber of the Order to delete, see Order.getOrderNumber()

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

Returns:

delete command

ofOrderNumber

static OrderDeleteCommand ofOrderNumber(String orderNumber,
                                        Long version,
                                        boolean eraseData)

Creates a command object to delete a Order by its orderNumber.

Parameters:

orderNumber - the orderNumber of the Order to delete, see Order.getOrderNumber()

version - the current version of the Order, 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