Package com.commercetools.api.models.order_edit

Interface StagedOrderSetStoreAction

All Superinterfaces:

ResourceUpdateAction<StagedOrderUpdateAction>, StagedOrderUpdateAction

All Known Implementing Classes:

StagedOrderSetStoreActionImpl

public interface StagedOrderSetStoreAction
extends StagedOrderUpdateAction

Sets the Store the Order is assigned to. It should be used to migrate Orders to a new Store. No validations are performed (such as that the Customer is allowed to create Orders in the Store).

Produces the Order Store Set Message. Returns a 400 error if store references the same Store the Order is currently assigned to, including if you try to remove the value when no Store is currently assigned.

Example to create an instance using the builder pattern

     StagedOrderSetStoreAction stagedOrderSetStoreAction = StagedOrderSetStoreAction.builder()
             .build()
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	SET_STORE	discriminator value for StagedOrderSetStoreAction

Method Summary

Modifier and Type	Method	Description
static StagedOrderSetStoreActionBuilder	builder()	builder factory method for StagedOrderSetStoreAction
static StagedOrderSetStoreActionBuilder	builder(StagedOrderSetStoreAction template)	create builder for StagedOrderSetStoreAction instance
static StagedOrderSetStoreAction	deepCopy(StagedOrderSetStoreAction template)	factory method to create a deep copy of StagedOrderSetStoreAction
@Valid StoreResourceIdentifier	getStore()	Value to set.
static StagedOrderSetStoreAction	of()	factory method
static StagedOrderSetStoreAction	of(StagedOrderSetStoreAction template)	factory method to create a shallow copy StagedOrderSetStoreAction
void	setStore(StoreResourceIdentifier store)	Value to set.
static com.fasterxml.jackson.core.type.TypeReference<StagedOrderSetStoreAction>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withStagedOrderSetStoreAction(Function<StagedOrderSetStoreAction,T> helper)	accessor map function

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

get

Methods inherited from interface com.commercetools.api.models.order.StagedOrderUpdateAction

getAction, withStagedOrderUpdateAction

Field Details

SET_STORE

static final String SET_STORE

discriminator value for StagedOrderSetStoreAction

See Also:

• Constant Field Values

Method Details

getStore

@Valid
@Valid StoreResourceIdentifier getStore()

Value to set. If empty, any existing value will be removed.

If store references the same Store the Order is currently assigned to or if you try to remove the value when no Store is currently assigned, a 400 error is returned.

Returns:

store

setStore

void setStore(StoreResourceIdentifier store)

Value to set. If empty, any existing value will be removed.

If store references the same Store the Order is currently assigned to or if you try to remove the value when no Store is currently assigned, a 400 error is returned.

Parameters:

store - value to be set

of

static StagedOrderSetStoreAction of()

factory method

Returns:

instance of StagedOrderSetStoreAction

of

static StagedOrderSetStoreAction of(StagedOrderSetStoreAction template)

factory method to create a shallow copy StagedOrderSetStoreAction

Parameters:

template - instance to be copied

Returns:

copy instance

deepCopy

@Nullable
static StagedOrderSetStoreAction deepCopy(@Nullable
 StagedOrderSetStoreAction template)

factory method to create a deep copy of StagedOrderSetStoreAction

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static StagedOrderSetStoreActionBuilder builder()

builder factory method for StagedOrderSetStoreAction

Returns:

builder

builder

static StagedOrderSetStoreActionBuilder builder(StagedOrderSetStoreAction template)

create builder for StagedOrderSetStoreAction instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withStagedOrderSetStoreAction

default <T> T withStagedOrderSetStoreAction(Function<StagedOrderSetStoreAction,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<StagedOrderSetStoreAction> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference