Package com.commercetools.api.models.category

Interface CategoryRemoveStoreAction

All Superinterfaces:

CategoryUpdateAction, ResourceUpdateAction<CategoryUpdateAction>

public interface CategoryRemoveStoreAction
extends CategoryUpdateAction

This action locks the Category and its parent Category. For details, see Category tree locking.

Every direct child Category must be assigned to at least one Store in that set; otherwise, the action is rejected.

• When updating a Category via the general endpoint, all Stores can be removed as a global Category is accessible in all Stores.
• When updating a Category via the Store-specific endpoint, you can remove the last Store only if at least one Store remains; otherwise, an InvalidOperation error is returned. If you do not have permission for the referenced Store, an InvalidInput error is returned.

Example to create an instance using the builder pattern

     CategoryRemoveStoreAction categoryRemoveStoreAction = CategoryRemoveStoreAction.builder()
             .store(storeBuilder -> storeBuilder)
             .build()
 

Field Summary

Fields

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

Method Summary

Modifier and Type	Method	Description
static CategoryRemoveStoreActionBuilder	builder()	builder factory method for CategoryRemoveStoreAction
static CategoryRemoveStoreActionBuilder	builder(CategoryRemoveStoreAction template)	create builder for CategoryRemoveStoreAction instance
CategoryRemoveStoreAction	copyDeep()
static CategoryRemoveStoreAction	deepCopy(CategoryRemoveStoreAction template)	factory method to create a deep copy of CategoryRemoveStoreAction
@NotNull @Valid StoreResourceIdentifier	getStore()	Value to remove from the Category's stores.
static CategoryRemoveStoreAction	of()	factory method
static CategoryRemoveStoreAction	of(CategoryRemoveStoreAction template)	factory method to create a shallow copy CategoryRemoveStoreAction
void	setStore(StoreResourceIdentifier store)	Value to remove from the Category's stores.
static tools.jackson.core.type.TypeReference<CategoryRemoveStoreAction>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withCategoryRemoveStoreAction(Function<CategoryRemoveStoreAction,T> helper)	accessor map function

Methods inherited from interface com.commercetools.api.models.category.CategoryUpdateAction

getAction, withCategoryUpdateAction

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

get

Field Details

REMOVE_STORE

static final String REMOVE_STORE

discriminator value for CategoryRemoveStoreAction

See Also:

• Constant Field Values

Method Details

getStore

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

Value to remove from the Category's stores.

Returns:

store

setStore

void setStore(StoreResourceIdentifier store)

Value to remove from the Category's stores.

Parameters:

store - value to be set

of

static CategoryRemoveStoreAction of()

factory method

Returns:

instance of CategoryRemoveStoreAction

of

static CategoryRemoveStoreAction of(CategoryRemoveStoreAction template)

factory method to create a shallow copy CategoryRemoveStoreAction

Parameters:

template - instance to be copied

Returns:

copy instance

copyDeep

CategoryRemoveStoreAction copyDeep()

Specified by:

copyDeep in interface CategoryUpdateAction

deepCopy

@Nullable
static CategoryRemoveStoreAction deepCopy(@Nullable
 CategoryRemoveStoreAction template)

factory method to create a deep copy of CategoryRemoveStoreAction

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static CategoryRemoveStoreActionBuilder builder()

builder factory method for CategoryRemoveStoreAction

Returns:

builder

builder

static CategoryRemoveStoreActionBuilder builder(CategoryRemoveStoreAction template)

create builder for CategoryRemoveStoreAction instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withCategoryRemoveStoreAction

default <T> T withCategoryRemoveStoreAction(Function<CategoryRemoveStoreAction,T> helper)

accessor map function

Type Parameters:

T - mapped type

Parameters:

helper - function to map the object

Returns:

mapped value

typeReference

static tools.jackson.core.type.TypeReference<CategoryRemoveStoreAction> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference