Package com.commercetools.api.models.order

Interface OrderUpdate

All Superinterfaces:

ResourceUpdate<OrderUpdate,OrderUpdateAction,OrderUpdateBuilder>

public interface OrderUpdate
extends ResourceUpdate<OrderUpdate,OrderUpdateAction,OrderUpdateBuilder>

OrderUpdate Example to create an instance using the builder pattern

     OrderUpdate orderUpdate = OrderUpdate.builder()
             .version(0.3)
             .plusActions(actionsBuilder -> actionsBuilder)
             .build()
 

Method Summary

Modifier and Type	Method	Description
static OrderUpdateBuilder	builder()	builder factory method for OrderUpdate
static OrderUpdateBuilder	builder(OrderUpdate template)	create builder for OrderUpdate instance
static OrderUpdate	deepCopy(OrderUpdate template)	factory method to create a deep copy of OrderUpdate
@NotNull @Valid List<OrderUpdateAction>	getActions()	Update actions to be performed on the Order.
@NotNull Long	getVersion()	Expected version of the Order on which the changes should be applied.
static OrderUpdate	of()	factory method
static OrderUpdate	of(OrderUpdate template)	factory method to create a shallow copy OrderUpdate
void	setActions(OrderUpdateAction... actions)	Update actions to be performed on the Order.
void	setActions(List<OrderUpdateAction> actions)	Update actions to be performed on the Order.
void	setVersion(Long version)	Expected version of the Order on which the changes should be applied.
static com.fasterxml.jackson.core.type.TypeReference<OrderUpdate>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withOrderUpdate(Function<OrderUpdate,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 Order 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<OrderUpdate,OrderUpdateAction,OrderUpdateBuilder>

Returns:

version

getActions

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

Update actions to be performed on the Order.

Specified by:

getActions in interface ResourceUpdate<OrderUpdate,OrderUpdateAction,OrderUpdateBuilder>

Returns:

actions

setVersion

void setVersion(Long version)

Expected version of the Order 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<OrderUpdate,OrderUpdateAction,OrderUpdateBuilder>

Parameters:

version - value to be set

setActions

void setActions(OrderUpdateAction... actions)

Update actions to be performed on the Order.

Parameters:

actions - values to be set

setActions

void setActions(List<OrderUpdateAction> actions)

Update actions to be performed on the Order.

Specified by:

setActions in interface ResourceUpdate<OrderUpdate,OrderUpdateAction,OrderUpdateBuilder>

Parameters:

actions - values to be set

of

static OrderUpdate of()

factory method

Returns:

instance of OrderUpdate

of

static OrderUpdate of(OrderUpdate template)

factory method to create a shallow copy OrderUpdate

Parameters:

template - instance to be copied

Returns:

copy instance

deepCopy

@Nullable
static OrderUpdate deepCopy(@Nullable
 OrderUpdate template)

factory method to create a deep copy of OrderUpdate

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static OrderUpdateBuilder builder()

builder factory method for OrderUpdate

Returns:

builder

builder

static OrderUpdateBuilder builder(OrderUpdate template)

create builder for OrderUpdate instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withOrderUpdate

default <T> T withOrderUpdate(Function<OrderUpdate,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<OrderUpdate> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference