io.sphere.sdk.shoppinglists.commands

Interface ShoppingListUpdateCommand

All Superinterfaces:

Command<ShoppingList>, ExpansionPathContainer<ShoppingList>, MetaModelReferenceExpansionDsl<ShoppingList,ShoppingListUpdateCommand,ShoppingListExpansionModel<ShoppingList>>, ReferenceExpansionDsl<ShoppingList,ShoppingListUpdateCommand>, ReferenceExpansionSupport<ShoppingList>, SphereRequest<ShoppingList>, UpdateCommand<ShoppingList>, UpdateCommandDsl<ShoppingList,ShoppingListUpdateCommand>

public interface ShoppingListUpdateCommand
extends UpdateCommandDsl<ShoppingList,ShoppingListUpdateCommand>, MetaModelReferenceExpansionDsl<ShoppingList,ShoppingListUpdateCommand,ShoppingListExpansionModel<ShoppingList>>

Updates a shopping list.

Known UpdateActions

• AddLineItem
• AddTextLineItem
• ChangeLineItemQuantity
• ChangeLineItemsOrder
• ChangeName
• ChangeTextLineItemName
• ChangeTextLineItemQuantity
• ChangeTextLineItemsOrder
• RemoveLineItem
• RemoveTextLineItem
• SetAnonymousId
• SetCustomField
• SetCustomType
• SetCustomer
• SetDeleteDaysAfterLastModification
• SetDescription
• SetKey
• SetLineItemCustomField
• SetLineItemCustomType
• SetSlug
• SetStore
• SetTextLineItemCustomField
• SetTextLineItemCustomType
• SetTextLineItemDescription

See Also:

ShoppingList

Method Summary

Modifier and Type	Method and Description
static ShoppingListUpdateCommand	of(Versioned<ShoppingList> versioned, List<? extends UpdateAction<ShoppingList>> updateActions) Creates a command to update a ShoppingList selected by its ID using several update actions.
static ShoppingListUpdateCommand	of(Versioned<ShoppingList> versioned, UpdateAction<ShoppingList> updateAction, UpdateAction<ShoppingList>... updateActions) Creates a command to update a ShoppingList selected by its ID using one update action.
static ShoppingListUpdateCommand	ofKey(String key, Long version, List<? extends UpdateAction<ShoppingList>> updateActions) Creates a command to update a ShoppingList selected by its key using several update actions.
static ShoppingListUpdateCommand	ofKey(String key, Long version, UpdateAction<ShoppingList> updateAction) Creates a command to update a ShoppingList selected by its key using one update action.

Methods inherited from interface io.sphere.sdk.commands.UpdateCommandDsl

plusUpdateActions, withAdditionalHttpQueryParameters, withUpdateActions, withVersion, withVersion

Methods inherited from interface io.sphere.sdk.commands.UpdateCommand

getUpdateActions

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

canDeserialize, deserialize, httpRequestIntent

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

Method Detail

of

static ShoppingListUpdateCommand of(Versioned<ShoppingList> versioned,
                                    List<? extends UpdateAction<ShoppingList>> updateActions)

Creates a command to update a ShoppingList selected by its ID using several update actions.

Parameters:

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

updateActions - the updates

Returns:

the update command for ShoppingList

of

@SafeVarargs
static ShoppingListUpdateCommand of(Versioned<ShoppingList> versioned,
                                                 UpdateAction<ShoppingList> updateAction,
                                                 UpdateAction<ShoppingList>... updateActions)

Creates a command to update a ShoppingList selected by its ID using one update action.

Parameters:

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

updateAction - the update to perform

updateActions - additional updates to perform

Returns:

the update command for ShoppingList

ofKey

static ShoppingListUpdateCommand ofKey(String key,
                                       Long version,
                                       List<? extends UpdateAction<ShoppingList>> updateActions)

Creates a command to update a ShoppingList selected by its key using several update actions.

Parameters:

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

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

updateActions - the updates

Returns:

the update command for ShoppingList

ofKey

static ShoppingListUpdateCommand ofKey(String key,
                                       Long version,
                                       UpdateAction<ShoppingList> updateAction)

Creates a command to update a ShoppingList selected by its key using one update action.

Parameters:

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

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

updateAction - the update to perform

Returns:

the update command for ShoppingList