Package com.commercetools.api.models.product_selection

Interface ProductSelectionSetVariantExclusionAction

All Superinterfaces:

ProductSelectionUpdateAction, ResourceUpdateAction<ProductSelectionUpdateAction>

public interface ProductSelectionSetVariantExclusionAction
extends ProductSelectionUpdateAction

Updates the Product Variant Exclusion of an existing Product Selection Assignment. A ProductVariantExclusion can only be set if the Product has already been excluded from the Product Selection with IndividualExclusion ProductSelectionMode.

If the specified Product is not assigned to the Product Selection, a ProductAssignmentMissing error is returned.

Example to create an instance using the builder pattern

     ProductSelectionSetVariantExclusionAction productSelectionSetVariantExclusionAction = ProductSelectionSetVariantExclusionAction.builder()
             .product(productBuilder -> productBuilder)
             .build()
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	SET_VARIANT_EXCLUSION	discriminator value for ProductSelectionSetVariantExclusionAction

Method Summary

Modifier and Type	Method	Description
static ProductSelectionSetVariantExclusionActionBuilder	builder()	builder factory method for ProductSelectionSetVariantExclusionAction
static ProductSelectionSetVariantExclusionActionBuilder	builder(ProductSelectionSetVariantExclusionAction template)	create builder for ProductSelectionSetVariantExclusionAction instance
ProductSelectionSetVariantExclusionAction	copyDeep()
static ProductSelectionSetVariantExclusionAction	deepCopy(ProductSelectionSetVariantExclusionAction template)	factory method to create a deep copy of ProductSelectionSetVariantExclusionAction
@NotNull @Valid ProductResourceIdentifier	getProduct()	ResourceIdentifier of the Product
@Valid ProductVariantExclusion	getVariantExclusion()	Determines which Variants of the previously excluded Product are to be included in the Product Selection with IndividualExclusion ProductSelectionMode.
static ProductSelectionSetVariantExclusionAction	of()	factory method
static ProductSelectionSetVariantExclusionAction	of(ProductSelectionSetVariantExclusionAction template)	factory method to create a shallow copy ProductSelectionSetVariantExclusionAction
void	setProduct(ProductResourceIdentifier product)	ResourceIdentifier of the Product
void	setVariantExclusion(ProductVariantExclusion variantExclusion)	Determines which Variants of the previously excluded Product are to be included in the Product Selection with IndividualExclusion ProductSelectionMode.
static com.fasterxml.jackson.core.type.TypeReference<ProductSelectionSetVariantExclusionAction>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withProductSelectionSetVariantExclusionAction(Function<ProductSelectionSetVariantExclusionAction,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

SET_VARIANT_EXCLUSION

static final String SET_VARIANT_EXCLUSION

discriminator value for ProductSelectionSetVariantExclusionAction

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()

Determines which Variants of the previously excluded Product are to be included in the Product Selection with IndividualExclusion ProductSelectionMode. Leave it empty to unset an existing Variant Exclusion.

Returns:

variantExclusion

setProduct

void setProduct(ProductResourceIdentifier product)

ResourceIdentifier of the Product

Parameters:

product - value to be set

setVariantExclusion

void setVariantExclusion(ProductVariantExclusion variantExclusion)

Determines which Variants of the previously excluded Product are to be included in the Product Selection with IndividualExclusion ProductSelectionMode. Leave it empty to unset an existing Variant Exclusion.

Parameters:

variantExclusion - value to be set

of

static ProductSelectionSetVariantExclusionAction of()

factory method

Returns:

instance of ProductSelectionSetVariantExclusionAction

of

static ProductSelectionSetVariantExclusionAction of(ProductSelectionSetVariantExclusionAction template)

factory method to create a shallow copy ProductSelectionSetVariantExclusionAction

Parameters:

template - instance to be copied

Returns:

copy instance

copyDeep

ProductSelectionSetVariantExclusionAction copyDeep()

Specified by:

copyDeep in interface ProductSelectionUpdateAction

deepCopy

@Nullable
static ProductSelectionSetVariantExclusionAction deepCopy(@Nullable
 ProductSelectionSetVariantExclusionAction template)

factory method to create a deep copy of ProductSelectionSetVariantExclusionAction

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static ProductSelectionSetVariantExclusionActionBuilder builder()

builder factory method for ProductSelectionSetVariantExclusionAction

Returns:

builder

builder

static ProductSelectionSetVariantExclusionActionBuilder builder(ProductSelectionSetVariantExclusionAction template)

create builder for ProductSelectionSetVariantExclusionAction instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withProductSelectionSetVariantExclusionAction

default <T> T withProductSelectionSetVariantExclusionAction(Function<ProductSelectionSetVariantExclusionAction,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<ProductSelectionSetVariantExclusionAction> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference