Package com.commercetools.api.models.order_edit

Interface OrderEditUpdate

All Superinterfaces:

ResourceUpdate<OrderEditUpdate,OrderEditUpdateAction,OrderEditUpdateBuilder>

public interface OrderEditUpdate
extends ResourceUpdate<OrderEditUpdate,OrderEditUpdateAction,OrderEditUpdateBuilder>

OrderEditUpdate Example to create an instance using the builder pattern

     OrderEditUpdate orderEditUpdate = OrderEditUpdate.builder()
             .version(0.3)
             .plusActions(actionsBuilder -> actionsBuilder)
             .build()
 

Method Summary

Modifier and Type	Method	Description
static OrderEditUpdateBuilder	builder()	builder factory method for OrderEditUpdate
static OrderEditUpdateBuilder	builder(OrderEditUpdate template)	create builder for OrderEditUpdate instance
static OrderEditUpdate	deepCopy(OrderEditUpdate template)	factory method to create a deep copy of OrderEditUpdate
@NotNull @Valid List<OrderEditUpdateAction>	getActions()	Update actions to be performed on the Order Edit.
Boolean	getDryRun()	If set to true, the Order Edit is applied on the Order without persisting it.
@NotNull Long	getVersion()	Expected version of the Order Edit on which the changes should be applied.
static OrderEditUpdate	of()	factory method
static OrderEditUpdate	of(OrderEditUpdate template)	factory method to create a shallow copy OrderEditUpdate
void	setActions(OrderEditUpdateAction... actions)	Update actions to be performed on the Order Edit.
void	setActions(List<OrderEditUpdateAction> actions)	Update actions to be performed on the Order Edit.
void	setDryRun(Boolean dryRun)	If set to true, the Order Edit is applied on the Order without persisting it.
void	setVersion(Long version)	Expected version of the Order Edit on which the changes should be applied.
static com.fasterxml.jackson.core.type.TypeReference<OrderEditUpdate>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withOrderEditUpdate(Function<OrderEditUpdate,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 Edit 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<OrderEditUpdate,OrderEditUpdateAction,OrderEditUpdateBuilder>

Returns:

version

getActions

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

Update actions to be performed on the Order Edit.

Specified by:

getActions in interface ResourceUpdate<OrderEditUpdate,OrderEditUpdateAction,OrderEditUpdateBuilder>

Returns:

actions

getDryRun

Boolean getDryRun()

If set to true, the Order Edit is applied on the Order without persisting it.

Returns:

dryRun

setVersion

void setVersion(Long version)

Expected version of the Order Edit 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<OrderEditUpdate,OrderEditUpdateAction,OrderEditUpdateBuilder>

Parameters:

version - value to be set

setActions

void setActions(OrderEditUpdateAction... actions)

Update actions to be performed on the Order Edit.

Parameters:

actions - values to be set

setActions

void setActions(List<OrderEditUpdateAction> actions)

Update actions to be performed on the Order Edit.

Specified by:

setActions in interface ResourceUpdate<OrderEditUpdate,OrderEditUpdateAction,OrderEditUpdateBuilder>

Parameters:

actions - values to be set

setDryRun

void setDryRun(Boolean dryRun)

If set to true, the Order Edit is applied on the Order without persisting it.

Parameters:

dryRun - value to be set

of

static OrderEditUpdate of()

factory method

Returns:

instance of OrderEditUpdate

of

static OrderEditUpdate of(OrderEditUpdate template)

factory method to create a shallow copy OrderEditUpdate

Parameters:

template - instance to be copied

Returns:

copy instance

deepCopy

@Nullable
static OrderEditUpdate deepCopy(@Nullable
 OrderEditUpdate template)

factory method to create a deep copy of OrderEditUpdate

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static OrderEditUpdateBuilder builder()

builder factory method for OrderEditUpdate

Returns:

builder

builder

static OrderEditUpdateBuilder builder(OrderEditUpdate template)

create builder for OrderEditUpdate instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withOrderEditUpdate

default <T> T withOrderEditUpdate(Function<OrderEditUpdate,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<OrderEditUpdate> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference