Package com.commercetools.api.models.store

Interface StoreAddProductSelectionAction

All Superinterfaces:

ResourceUpdateAction<StoreUpdateAction>, StoreUpdateAction

All Known Implementing Classes:

StoreAddProductSelectionActionImpl

public interface StoreAddProductSelectionAction
extends StoreUpdateAction

To make all included Products available to your customers of a given Store, add the Product Selections to the respective Store. This action has no effect if the given Product Selection is already present in the Store and has the same active flag.

Example to create an instance using the builder pattern

     StoreAddProductSelectionAction storeAddProductSelectionAction = StoreAddProductSelectionAction.builder()
             .productSelection(productSelectionBuilder -> productSelectionBuilder)
             .build()
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ADD_PRODUCT_SELECTION	discriminator value for StoreAddProductSelectionAction

Method Summary

Modifier and Type	Method	Description
static StoreAddProductSelectionActionBuilder	builder()	builder factory method for StoreAddProductSelectionAction
static StoreAddProductSelectionActionBuilder	builder(StoreAddProductSelectionAction template)	create builder for StoreAddProductSelectionAction instance
static StoreAddProductSelectionAction	deepCopy(StoreAddProductSelectionAction template)	factory method to create a deep copy of StoreAddProductSelectionAction
Boolean	getActive()	Set to true to make all Products assigned to the referenced Product Selection available in the Store.
@NotNull @Valid ProductSelectionResourceIdentifier	getProductSelection()	Product Selection to add to the Store either activated or deactivated.
static StoreAddProductSelectionAction	of()	factory method
static StoreAddProductSelectionAction	of(StoreAddProductSelectionAction template)	factory method to create a shallow copy StoreAddProductSelectionAction
void	setActive(Boolean active)	Set to true to make all Products assigned to the referenced Product Selection available in the Store.
void	setProductSelection(ProductSelectionResourceIdentifier productSelection)	Product Selection to add to the Store either activated or deactivated.
static com.fasterxml.jackson.core.type.TypeReference<StoreAddProductSelectionAction>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withStoreAddProductSelectionAction(Function<StoreAddProductSelectionAction,T> helper)	accessor map function

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

get

Methods inherited from interface com.commercetools.api.models.store.StoreUpdateAction

getAction, withStoreUpdateAction

Field Details

ADD_PRODUCT_SELECTION

static final String ADD_PRODUCT_SELECTION

discriminator value for StoreAddProductSelectionAction

See Also:

• Constant Field Values

Method Details

getProductSelection

@NotNull
@Valid
@NotNull @Valid ProductSelectionResourceIdentifier getProductSelection()

Product Selection to add to the Store either activated or deactivated.

Returns:

productSelection

getActive

Boolean getActive()

Set to true to make all Products assigned to the referenced Product Selection available in the Store.

Returns:

active

setProductSelection

void setProductSelection(ProductSelectionResourceIdentifier productSelection)

Product Selection to add to the Store either activated or deactivated.

Parameters:

productSelection - value to be set

setActive

void setActive(Boolean active)

Set to true to make all Products assigned to the referenced Product Selection available in the Store.

Parameters:

active - value to be set

of

static StoreAddProductSelectionAction of()

factory method

Returns:

instance of StoreAddProductSelectionAction

of

static StoreAddProductSelectionAction of(StoreAddProductSelectionAction template)

factory method to create a shallow copy StoreAddProductSelectionAction

Parameters:

template - instance to be copied

Returns:

copy instance

deepCopy

@Nullable
static StoreAddProductSelectionAction deepCopy(@Nullable
 StoreAddProductSelectionAction template)

factory method to create a deep copy of StoreAddProductSelectionAction

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static StoreAddProductSelectionActionBuilder builder()

builder factory method for StoreAddProductSelectionAction

Returns:

builder

builder

static StoreAddProductSelectionActionBuilder builder(StoreAddProductSelectionAction template)

create builder for StoreAddProductSelectionAction instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withStoreAddProductSelectionAction

default <T> T withStoreAddProductSelectionAction(Function<StoreAddProductSelectionAction,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<StoreAddProductSelectionAction> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference