Package com.commercetools.api.models.product_tailoring

Interface ProductTailoringSetAttributeInAllVariantsAction

All Superinterfaces:

ProductTailoringUpdateAction

public interface ProductTailoringSetAttributeInAllVariantsAction
extends ProductTailoringUpdateAction

Adds, removes, or changes a tailored Attribute in all Product Variants of a Product at the same time. This action is useful for setting tailored values for Attributes with the Constraint SameForAll.

Example to create an instance using the builder pattern

     ProductTailoringSetAttributeInAllVariantsAction productTailoringSetAttributeInAllVariantsAction = ProductTailoringSetAttributeInAllVariantsAction.builder()
             .name("{name}")
             .build()
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	SET_ATTRIBUTE_IN_ALL_VARIANTS	discriminator value for ProductTailoringSetAttributeInAllVariantsAction

Method Summary

Modifier and Type	Method	Description
static ProductTailoringSetAttributeInAllVariantsActionBuilder	builder()	builder factory method for ProductTailoringSetAttributeInAllVariantsAction
static ProductTailoringSetAttributeInAllVariantsActionBuilder	builder(ProductTailoringSetAttributeInAllVariantsAction template)	create builder for ProductTailoringSetAttributeInAllVariantsAction instance
ProductTailoringSetAttributeInAllVariantsAction	copyDeep()
static ProductTailoringSetAttributeInAllVariantsAction	deepCopy(ProductTailoringSetAttributeInAllVariantsAction template)	factory method to create a deep copy of ProductTailoringSetAttributeInAllVariantsAction
@NotNull String	getName()	The name of the Attribute to set.
Boolean	getStaged()	If true, only the staged Attributes are set.
Object	getValue()	Value to set for the Attributes.
static ProductTailoringSetAttributeInAllVariantsAction	of()	factory method
static ProductTailoringSetAttributeInAllVariantsAction	of(ProductTailoringSetAttributeInAllVariantsAction template)	factory method to create a shallow copy ProductTailoringSetAttributeInAllVariantsAction
void	setName(String name)	The name of the Attribute to set.
void	setStaged(Boolean staged)	If true, only the staged Attributes are set.
void	setValue(Object value)	Value to set for the Attributes.
static com.fasterxml.jackson.core.type.TypeReference<ProductTailoringSetAttributeInAllVariantsAction>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withProductTailoringSetAttributeInAllVariantsAction(Function<ProductTailoringSetAttributeInAllVariantsAction,T> helper)	accessor map function

Methods inherited from interface com.commercetools.api.models.product_tailoring.ProductTailoringUpdateAction

getAction, withProductTailoringUpdateAction

Field Details

SET_ATTRIBUTE_IN_ALL_VARIANTS

static final String SET_ATTRIBUTE_IN_ALL_VARIANTS

discriminator value for ProductTailoringSetAttributeInAllVariantsAction

See Also:

• Constant Field Values

Method Details

getName

@NotNull
@NotNull String getName()

The name of the Attribute to set.

Returns:

name

getValue

Object getValue()

Value to set for the Attributes. If empty, any existing value will be removed.

The AttributeType determines the format of the Attribute value to be provided:

• For Enum Type and Localized Enum Type, use the key of the Plain Enum Value or Localized Enum Value objects, or the complete objects as value.
• For Localizable Text Type, use the LocalizedString object as value.
• For Money Type Attributes, use the Money object as value.
• For Set Type Attributes, use the entire set object as value.
• For Reference Type Attributes, use the Reference object as value.

Tailoring of Nested Type Attributes is not supported.

Returns:

value

getStaged

Boolean getStaged()

If true, only the staged Attributes are set. If false, both the current and staged Attributes are set.

Returns:

staged

setName

void setName(String name)

The name of the Attribute to set.

Parameters:

name - value to be set

setValue

void setValue(Object value)

Value to set for the Attributes. If empty, any existing value will be removed.

The AttributeType determines the format of the Attribute value to be provided:

• For Enum Type and Localized Enum Type, use the key of the Plain Enum Value or Localized Enum Value objects, or the complete objects as value.
• For Localizable Text Type, use the LocalizedString object as value.
• For Money Type Attributes, use the Money object as value.
• For Set Type Attributes, use the entire set object as value.
• For Reference Type Attributes, use the Reference object as value.

Tailoring of Nested Type Attributes is not supported.

Parameters:

value - value to be set

setStaged

void setStaged(Boolean staged)

If true, only the staged Attributes are set. If false, both the current and staged Attributes are set.

Parameters:

staged - value to be set

of

static ProductTailoringSetAttributeInAllVariantsAction of()

factory method

Returns:

instance of ProductTailoringSetAttributeInAllVariantsAction

of

static ProductTailoringSetAttributeInAllVariantsAction of(ProductTailoringSetAttributeInAllVariantsAction template)

factory method to create a shallow copy ProductTailoringSetAttributeInAllVariantsAction

Parameters:

template - instance to be copied

Returns:

copy instance

copyDeep

ProductTailoringSetAttributeInAllVariantsAction copyDeep()

Specified by:

copyDeep in interface ProductTailoringUpdateAction

deepCopy

@Nullable
static ProductTailoringSetAttributeInAllVariantsAction deepCopy(@Nullable
 ProductTailoringSetAttributeInAllVariantsAction template)

factory method to create a deep copy of ProductTailoringSetAttributeInAllVariantsAction

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static ProductTailoringSetAttributeInAllVariantsActionBuilder builder()

builder factory method for ProductTailoringSetAttributeInAllVariantsAction

Returns:

builder

builder

static ProductTailoringSetAttributeInAllVariantsActionBuilder builder(ProductTailoringSetAttributeInAllVariantsAction template)

create builder for ProductTailoringSetAttributeInAllVariantsAction instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withProductTailoringSetAttributeInAllVariantsAction

default <T> T withProductTailoringSetAttributeInAllVariantsAction(Function<ProductTailoringSetAttributeInAllVariantsAction,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<ProductTailoringSetAttributeInAllVariantsAction> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference