io.sphere.sdk.shoppinglists.commands

Interface ShoppingListDeleteCommand

All Superinterfaces:

Command<ShoppingList>, DeleteCommand<ShoppingList>, ExpansionPathContainer<ShoppingList>, MetaModelReferenceExpansionDsl<ShoppingList,ShoppingListDeleteCommand,ShoppingListExpansionModel<ShoppingList>>, ReferenceExpansionDsl<ShoppingList,ShoppingListDeleteCommand>, ReferenceExpansionSupport<ShoppingList>, SphereRequest<ShoppingList>

public interface ShoppingListDeleteCommand
extends MetaModelReferenceExpansionDsl<ShoppingList,ShoppingListDeleteCommand,ShoppingListExpansionModel<ShoppingList>>, DeleteCommand<ShoppingList>

Deletes a shopping list.

See Also:

ShoppingList

Method Summary

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

Creates a command object to delete a ShoppingList by ID.

Parameters:

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

Returns:

delete command

of

static ShoppingListDeleteCommand of(Versioned<ShoppingList> versioned,
                                    boolean eraseData)

Creates a command object to delete a ShoppingList by ID.

Parameters:

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

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

Parameters:

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

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

Returns:

delete command

ofKey

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

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

Parameters:

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

version - the current version of the ShoppingList, 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 ShoppingListDeleteCommand ofId(String id,
                                      Long version)

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

Parameters:

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

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

Returns:

delete command

ofId

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

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

Parameters:

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

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