io.sphere.sdk.customers.commands

Interface CustomerDeleteCommand

All Superinterfaces:

Command<Customer>, DeleteCommand<Customer>, ExpansionPathContainer<Customer>, MetaModelReferenceExpansionDsl<Customer,CustomerDeleteCommand,CustomerExpansionModel<Customer>>, ReferenceExpansionDsl<Customer,CustomerDeleteCommand>, ReferenceExpansionSupport<Customer>, SphereRequest<Customer>

public interface CustomerDeleteCommand
extends MetaModelReferenceExpansionDsl<Customer,CustomerDeleteCommand,CustomerExpansionModel<Customer>>, DeleteCommand<Customer>

Deletes a customer.

final CustomerSignInResult result = client().executeBlocking(CustomerCreateCommand.of(newCustomerDraft()));
final Customer customer = result.getCustomer();
client().executeBlocking(CustomerDeleteCommand.of(customer));
final Cart cart = client().executeBlocking(CartByCustomerIdGet.of(customer));
assertThat(cart).isNull();
See the test code.

See Also:

Customer

Method Summary

Modifier and Type	Method and Description
static CustomerDeleteCommand	of(Versioned<Customer> versioned) Creates a command object to delete a Customer by ID.
static CustomerDeleteCommand	of(Versioned<Customer> versioned, boolean eraseData) Creates a command object to delete a Customer by ID.
static CustomerDeleteCommand	ofKey(String key, Long version) Creates a command object to delete a Customer by its key.
static CustomerDeleteCommand	ofKey(String key, Long version, boolean eraseData) Creates a command object to delete a Customer 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 CustomerDeleteCommand of(Versioned<Customer> versioned)

Creates a command object to delete a Customer by ID.

Parameters:

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

Returns:

delete command

of

static CustomerDeleteCommand of(Versioned<Customer> versioned,
                                boolean eraseData)

Creates a command object to delete a Customer by ID.

Parameters:

versioned - the object to delete (so directly a Customer) 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 CustomerDeleteCommand ofKey(String key,
                                   Long version)

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

Parameters:

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

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

Returns:

delete command

ofKey

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

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

Parameters:

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

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