Package com.commercetools.api.models.business_unit

Interface BusinessUnitSetStoresAction

All Superinterfaces:

BusinessUnitUpdateAction, ResourceUpdateAction<BusinessUnitUpdateAction>

public interface BusinessUnitSetStoresAction
extends BusinessUnitUpdateAction

Sets the Stores of the Business Unit. Can only be set if the Business Unit storeMode is Explicit. Carts and Orders created after the Set Stores update must use the new Stores of the Business Unit and, if set, their Product Selections, and Channels. Orders created before the Set Stores update action remain unchanged. Setting the Stores on a Business Unit generates a BusinessUnitStoresSet Message.

Example to create an instance using the builder pattern

     BusinessUnitSetStoresAction businessUnitSetStoresAction = BusinessUnitSetStoresAction.builder()
             .plusStores(storesBuilder -> storesBuilder)
             .build()
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	SET_STORES	discriminator value for BusinessUnitSetStoresAction

Method Summary

Modifier and Type	Method	Description
static BusinessUnitSetStoresActionBuilder	builder()	builder factory method for BusinessUnitSetStoresAction
static BusinessUnitSetStoresActionBuilder	builder(BusinessUnitSetStoresAction template)	create builder for BusinessUnitSetStoresAction instance
static BusinessUnitSetStoresAction	deepCopy(BusinessUnitSetStoresAction template)	factory method to create a deep copy of BusinessUnitSetStoresAction
@NotNull @Valid List<StoreResourceIdentifier>	getStores()	Stores to set.
static BusinessUnitSetStoresAction	of()	factory method
static BusinessUnitSetStoresAction	of(BusinessUnitSetStoresAction template)	factory method to create a shallow copy BusinessUnitSetStoresAction
void	setStores(StoreResourceIdentifier... stores)	Stores to set.
void	setStores(List<StoreResourceIdentifier> stores)	Stores to set.
static com.fasterxml.jackson.core.type.TypeReference<BusinessUnitSetStoresAction>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withBusinessUnitSetStoresAction(Function<BusinessUnitSetStoresAction,T> helper)	accessor map function

Methods inherited from interface com.commercetools.api.models.business_unit.BusinessUnitUpdateAction

getAction, withBusinessUnitUpdateAction

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

get

Field Details

SET_STORES

static final String SET_STORES

discriminator value for BusinessUnitSetStoresAction

See Also:

• Constant Field Values

Method Details

getStores

@NotNull
@Valid
@NotNull @Valid List<StoreResourceIdentifier> getStores()

Stores to set. Overrides the current list of Stores.

Returns:

stores

setStores

void setStores(StoreResourceIdentifier... stores)

Stores to set. Overrides the current list of Stores.

Parameters:

stores - values to be set

setStores

void setStores(List<StoreResourceIdentifier> stores)

Stores to set. Overrides the current list of Stores.

Parameters:

stores - values to be set

of

static BusinessUnitSetStoresAction of()

factory method

Returns:

instance of BusinessUnitSetStoresAction

of

static BusinessUnitSetStoresAction of(BusinessUnitSetStoresAction template)

factory method to create a shallow copy BusinessUnitSetStoresAction

Parameters:

template - instance to be copied

Returns:

copy instance

deepCopy

@Nullable
static BusinessUnitSetStoresAction deepCopy(@Nullable
 BusinessUnitSetStoresAction template)

factory method to create a deep copy of BusinessUnitSetStoresAction

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static BusinessUnitSetStoresActionBuilder builder()

builder factory method for BusinessUnitSetStoresAction

Returns:

builder

builder

static BusinessUnitSetStoresActionBuilder builder(BusinessUnitSetStoresAction template)

create builder for BusinessUnitSetStoresAction instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withBusinessUnitSetStoresAction

default <T> T withBusinessUnitSetStoresAction(Function<BusinessUnitSetStoresAction,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<BusinessUnitSetStoresAction> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference