Package com.commercetools.api.models.business_unit

Interface BusinessUnitRemoveStoreAction

All Superinterfaces:

BusinessUnitUpdateAction, ResourceUpdateAction<BusinessUnitUpdateAction>

public interface BusinessUnitRemoveStoreAction
extends BusinessUnitUpdateAction

Removes a Store from the Business Unit. Newly created Carts and Orders can no longer reference the removed Store for the Business Unit. We recommend cleaning up unordered Carts that still have the Store assigned after calling this update action since those cannot be converted to Orders. Orders created before the Store was removed remain unchanged. Generates a BusinessUnitStoreRemoved Message. Only applicable when storeMode is Explicit.

Example to create an instance using the builder pattern

     BusinessUnitRemoveStoreAction businessUnitRemoveStoreAction = BusinessUnitRemoveStoreAction.builder()
             .store(storeBuilder -> storeBuilder)
             .build()
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	REMOVE_STORE	discriminator value for BusinessUnitRemoveStoreAction

Method Summary

Modifier and Type	Method	Description
static BusinessUnitRemoveStoreActionBuilder	builder()	builder factory method for BusinessUnitRemoveStoreAction
static BusinessUnitRemoveStoreActionBuilder	builder(BusinessUnitRemoveStoreAction template)	create builder for BusinessUnitRemoveStoreAction instance
static BusinessUnitRemoveStoreAction	deepCopy(BusinessUnitRemoveStoreAction template)	factory method to create a deep copy of BusinessUnitRemoveStoreAction
@NotNull @Valid StoreResourceIdentifier	getStore()	Store to remove.
static BusinessUnitRemoveStoreAction	of()	factory method
static BusinessUnitRemoveStoreAction	of(BusinessUnitRemoveStoreAction template)	factory method to create a shallow copy BusinessUnitRemoveStoreAction
void	setStore(StoreResourceIdentifier store)	Store to remove.
static com.fasterxml.jackson.core.type.TypeReference<BusinessUnitRemoveStoreAction>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withBusinessUnitRemoveStoreAction(Function<BusinessUnitRemoveStoreAction,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

REMOVE_STORE

static final String REMOVE_STORE

discriminator value for BusinessUnitRemoveStoreAction

See Also:

• Constant Field Values

Method Details

getStore

@NotNull
@Valid
@NotNull @Valid StoreResourceIdentifier getStore()

Store to remove.

Returns:

store

setStore

void setStore(StoreResourceIdentifier store)

Store to remove.

Parameters:

store - value to be set

of

static BusinessUnitRemoveStoreAction of()

factory method

Returns:

instance of BusinessUnitRemoveStoreAction

of

static BusinessUnitRemoveStoreAction of(BusinessUnitRemoveStoreAction template)

factory method to create a shallow copy BusinessUnitRemoveStoreAction

Parameters:

template - instance to be copied

Returns:

copy instance

deepCopy

@Nullable
static BusinessUnitRemoveStoreAction deepCopy(@Nullable
 BusinessUnitRemoveStoreAction template)

factory method to create a deep copy of BusinessUnitRemoveStoreAction

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static BusinessUnitRemoveStoreActionBuilder builder()

builder factory method for BusinessUnitRemoveStoreAction

Returns:

builder

builder

static BusinessUnitRemoveStoreActionBuilder builder(BusinessUnitRemoveStoreAction template)

create builder for BusinessUnitRemoveStoreAction instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withBusinessUnitRemoveStoreAction

default <T> T withBusinessUnitRemoveStoreAction(Function<BusinessUnitRemoveStoreAction,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<BusinessUnitRemoveStoreAction> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference