Package com.commercetools.api.models.product_selection

Interface ProductSelectionExcludeProductAction

All Superinterfaces:

ProductSelectionUpdateAction, ResourceUpdateAction<ProductSelectionUpdateAction>

public interface ProductSelectionExcludeProductAction
extends ProductSelectionUpdateAction

Excludes a Product from a Product Selection with IndividualExclusion ProductSelectionMode.

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

Example to create an instance using the builder pattern

     ProductSelectionExcludeProductAction productSelectionExcludeProductAction = ProductSelectionExcludeProductAction.builder()
             .product(productBuilder -> productBuilder)
             .build()
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	EXCLUDE_PRODUCT	discriminator value for ProductSelectionExcludeProductAction

Method Summary

Modifier and Type	Method	Description
static ProductSelectionExcludeProductActionBuilder	builder()	builder factory method for ProductSelectionExcludeProductAction
static ProductSelectionExcludeProductActionBuilder	builder(ProductSelectionExcludeProductAction template)	create builder for ProductSelectionExcludeProductAction instance
static ProductSelectionExcludeProductAction	deepCopy(ProductSelectionExcludeProductAction template)	factory method to create a deep copy of ProductSelectionExcludeProductAction
@NotNull @Valid ProductResourceIdentifier	getProduct()	ResourceIdentifier of the Product
@Valid ProductVariantExclusion	getVariantExclusion()	Defines which Variants of the Product will be excluded from the Product Selection.
static ProductSelectionExcludeProductAction	of()	factory method
static ProductSelectionExcludeProductAction	of(ProductSelectionExcludeProductAction template)	factory method to create a shallow copy ProductSelectionExcludeProductAction
void	setProduct(ProductResourceIdentifier product)	ResourceIdentifier of the Product
void	setVariantExclusion(ProductVariantExclusion variantExclusion)	Defines which Variants of the Product will be excluded from the Product Selection.
static com.fasterxml.jackson.core.type.TypeReference<ProductSelectionExcludeProductAction>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withProductSelectionExcludeProductAction(Function<ProductSelectionExcludeProductAction,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

EXCLUDE_PRODUCT

static final String EXCLUDE_PRODUCT

discriminator value for ProductSelectionExcludeProductAction

See Also:

• Constant Field Values

Method Details

getProduct

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

ResourceIdentifier of the Product

Returns:

product

getVariantExclusion

@Valid
@Valid ProductVariantExclusion getVariantExclusion()

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

Returns:

variantExclusion

setProduct

void setProduct(ProductResourceIdentifier product)

ResourceIdentifier of the Product

Parameters:

product - value to be set

setVariantExclusion

void setVariantExclusion(ProductVariantExclusion variantExclusion)

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

Parameters:

variantExclusion - value to be set

of

static ProductSelectionExcludeProductAction of()

factory method

Returns:

instance of ProductSelectionExcludeProductAction

of

static ProductSelectionExcludeProductAction of(ProductSelectionExcludeProductAction template)

factory method to create a shallow copy ProductSelectionExcludeProductAction

Parameters:

template - instance to be copied

Returns:

copy instance

deepCopy

@Nullable
static ProductSelectionExcludeProductAction deepCopy(@Nullable
 ProductSelectionExcludeProductAction template)

factory method to create a deep copy of ProductSelectionExcludeProductAction

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static ProductSelectionExcludeProductActionBuilder builder()

builder factory method for ProductSelectionExcludeProductAction

Returns:

builder

builder

static ProductSelectionExcludeProductActionBuilder builder(ProductSelectionExcludeProductAction template)

create builder for ProductSelectionExcludeProductAction instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withProductSelectionExcludeProductAction

default <T> T withProductSelectionExcludeProductAction(Function<ProductSelectionExcludeProductAction,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<ProductSelectionExcludeProductAction> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference