Package com.commercetools.api.models.shopping_list

Interface ShoppingListUpdate

All Superinterfaces:

ResourceUpdate<ShoppingListUpdate,ShoppingListUpdateAction,ShoppingListUpdateBuilder>

All Known Implementing Classes:

ShoppingListUpdateImpl

public interface ShoppingListUpdate
extends ResourceUpdate<ShoppingListUpdate,ShoppingListUpdateAction,ShoppingListUpdateBuilder>

ShoppingListUpdate Example to create an instance using the builder pattern

     ShoppingListUpdate shoppingListUpdate = ShoppingListUpdate.builder()
             .version(0.3)
             .plusActions(actionsBuilder -> actionsBuilder)
             .build()
 

Method Summary

Modifier and Type	Method	Description
static ShoppingListUpdateBuilder	builder()	builder factory method for ShoppingListUpdate
static ShoppingListUpdateBuilder	builder(ShoppingListUpdate template)	create builder for ShoppingListUpdate instance
static ShoppingListUpdate	deepCopy(ShoppingListUpdate template)	factory method to create a deep copy of ShoppingListUpdate
@NotNull @Valid List<ShoppingListUpdateAction>	getActions()	List of update actions to be performed on the ShoppingList.
@NotNull Long	getVersion()	Expected version of the ShoppingList on which the changes should be applied.
static ShoppingListUpdate	of()	factory method
static ShoppingListUpdate	of(ShoppingListUpdate template)	factory method to create a shallow copy ShoppingListUpdate
void	setActions(ShoppingListUpdateAction... actions)	List of update actions to be performed on the ShoppingList.
void	setActions(List<ShoppingListUpdateAction> actions)	List of update actions to be performed on the ShoppingList.
void	setVersion(Long version)	Expected version of the ShoppingList on which the changes should be applied.
static com.fasterxml.jackson.core.type.TypeReference<ShoppingListUpdate>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withShoppingListUpdate(Function<ShoppingListUpdate,T> helper)	accessor map function

Methods inherited from interface com.commercetools.api.models.ResourceUpdate

get

Method Details

getVersion

@NotNull
@NotNull Long getVersion()

Expected version of the ShoppingList on which the changes should be applied. If the expected version does not match the actual version, a ConcurrentModification error will be returned.

Specified by:

getVersion in interface ResourceUpdate<ShoppingListUpdate,ShoppingListUpdateAction,ShoppingListUpdateBuilder>

Returns:

version

getActions

@NotNull
@Valid
@NotNull @Valid List<ShoppingListUpdateAction> getActions()

List of update actions to be performed on the ShoppingList.

Specified by:

getActions in interface ResourceUpdate<ShoppingListUpdate,ShoppingListUpdateAction,ShoppingListUpdateBuilder>

Returns:

actions

setVersion

void setVersion(Long version)

Expected version of the ShoppingList on which the changes should be applied. If the expected version does not match the actual version, a ConcurrentModification error will be returned.

Specified by:

setVersion in interface ResourceUpdate<ShoppingListUpdate,ShoppingListUpdateAction,ShoppingListUpdateBuilder>

Parameters:

version - value to be set

setActions

void setActions(ShoppingListUpdateAction... actions)

List of update actions to be performed on the ShoppingList.

Parameters:

actions - values to be set

setActions

void setActions(List<ShoppingListUpdateAction> actions)

List of update actions to be performed on the ShoppingList.

Specified by:

setActions in interface ResourceUpdate<ShoppingListUpdate,ShoppingListUpdateAction,ShoppingListUpdateBuilder>

Parameters:

actions - values to be set

of

static ShoppingListUpdate of()

factory method

Returns:

instance of ShoppingListUpdate

of

static ShoppingListUpdate of(ShoppingListUpdate template)

factory method to create a shallow copy ShoppingListUpdate

Parameters:

template - instance to be copied

Returns:

copy instance

deepCopy

@Nullable
static ShoppingListUpdate deepCopy(@Nullable
 ShoppingListUpdate template)

factory method to create a deep copy of ShoppingListUpdate

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static ShoppingListUpdateBuilder builder()

builder factory method for ShoppingListUpdate

Returns:

builder

builder

static ShoppingListUpdateBuilder builder(ShoppingListUpdate template)

create builder for ShoppingListUpdate instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withShoppingListUpdate

default <T> T withShoppingListUpdate(Function<ShoppingListUpdate,T> helper)

accessor map function

Type Parameters:

T - mapped type

Parameters:

helper - function to map the object

Returns:

mapped value

typeReference

static com.fasterxml.jackson.core.type.TypeReference<ShoppingListUpdate> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference