Package com.commercetools.api.models.product_selection

Interface ProductSelectionAddProductAction

All Superinterfaces:

ProductSelectionUpdateAction, ResourceUpdateAction<ProductSelectionUpdateAction>

All Known Implementing Classes:

ProductSelectionAddProductActionImpl

public interface ProductSelectionAddProductAction
extends ProductSelectionUpdateAction

Adds a Product to the Product Selection.

If the specified Product is already assigned to the Product Selection, but the existing Product Selection has a different Product Variant Selection, a ProductPresentWithDifferentVariantSelection error is returned.

Example to create an instance using the builder pattern

     ProductSelectionAddProductAction productSelectionAddProductAction = ProductSelectionAddProductAction.builder()
             .product(productBuilder -> productBuilder)
             .build()
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ADD_PRODUCT	discriminator value for ProductSelectionAddProductAction

Method Summary

Modifier and Type	Method	Description
static ProductSelectionAddProductActionBuilder	builder()	builder factory method for ProductSelectionAddProductAction
static ProductSelectionAddProductActionBuilder	builder(ProductSelectionAddProductAction template)	create builder for ProductSelectionAddProductAction instance
static ProductSelectionAddProductAction	deepCopy(ProductSelectionAddProductAction template)	factory method to create a deep copy of ProductSelectionAddProductAction
@NotNull @Valid ProductResourceIdentifier	getProduct()	ResourceIdentifier of the Product
@Valid ProductVariantSelection	getVariantSelection()	Defines which Variants of the Product will be included in the Product Selection.
static ProductSelectionAddProductAction	of()	factory method
static ProductSelectionAddProductAction	of(ProductSelectionAddProductAction template)	factory method to create a shallow copy ProductSelectionAddProductAction
void	setProduct(ProductResourceIdentifier product)	ResourceIdentifier of the Product
void	setVariantSelection(ProductVariantSelection variantSelection)	Defines which Variants of the Product will be included in the Product Selection.
static com.fasterxml.jackson.core.type.TypeReference<ProductSelectionAddProductAction>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withProductSelectionAddProductAction(Function<ProductSelectionAddProductAction,T> helper)	accessor map function

Methods inherited from interface com.commercetools.api.models.product_selection.ProductSelectionUpdateAction

getAction, withProductSelectionUpdateAction

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

get

Field Details

ADD_PRODUCT

static final String ADD_PRODUCT

discriminator value for ProductSelectionAddProductAction

See Also:

• Constant Field Values

Method Details

getProduct

@NotNull
@Valid
@NotNull @Valid ProductResourceIdentifier getProduct()

ResourceIdentifier of the Product

Returns:

product

getVariantSelection

@Valid
@Valid ProductVariantSelection getVariantSelection()

Defines which Variants of the Product will be included in the Product Selection. If not supplied all Variants are deemed to be included.

Returns:

variantSelection

setProduct

void setProduct(ProductResourceIdentifier product)

ResourceIdentifier of the Product

Parameters:

product - value to be set

setVariantSelection

void setVariantSelection(ProductVariantSelection variantSelection)

Defines which Variants of the Product will be included in the Product Selection. If not supplied all Variants are deemed to be included.

Parameters:

variantSelection - value to be set

of

static ProductSelectionAddProductAction of()

factory method

Returns:

instance of ProductSelectionAddProductAction

of

static ProductSelectionAddProductAction of(ProductSelectionAddProductAction template)

factory method to create a shallow copy ProductSelectionAddProductAction

Parameters:

template - instance to be copied

Returns:

copy instance

deepCopy

@Nullable
static ProductSelectionAddProductAction deepCopy(@Nullable
 ProductSelectionAddProductAction template)

factory method to create a deep copy of ProductSelectionAddProductAction

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static ProductSelectionAddProductActionBuilder builder()

builder factory method for ProductSelectionAddProductAction

Returns:

builder

builder

static ProductSelectionAddProductActionBuilder builder(ProductSelectionAddProductAction template)

create builder for ProductSelectionAddProductAction instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withProductSelectionAddProductAction

default <T> T withProductSelectionAddProductAction(Function<ProductSelectionAddProductAction,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<ProductSelectionAddProductAction> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference