Package com.commercetools.api.models.product_type

Interface ProductTypeChangeAttributeNameAction

All Superinterfaces:

ProductTypeUpdateAction, ResourceUpdateAction<ProductTypeUpdateAction>

All Known Implementing Classes:

ProductTypeChangeAttributeNameActionImpl

public interface ProductTypeChangeAttributeNameAction
extends ProductTypeUpdateAction

Renames an AttributeDefinition and also renames all corresponding Attributes on all Products with this ProductType. The renaming of the Attributes is eventually consistent.

If the AttributeDefinition name to be changed does not exist, an AttributeNameDoesNotExist error is returned.

Example to create an instance using the builder pattern

     ProductTypeChangeAttributeNameAction productTypeChangeAttributeNameAction = ProductTypeChangeAttributeNameAction.builder()
             .attributeName("{attributeName}")
             .newAttributeName("{newAttributeName}")
             .build()
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CHANGE_ATTRIBUTE_NAME	discriminator value for ProductTypeChangeAttributeNameAction

Method Summary

Modifier and Type	Method	Description
static ProductTypeChangeAttributeNameActionBuilder	builder()	builder factory method for ProductTypeChangeAttributeNameAction
static ProductTypeChangeAttributeNameActionBuilder	builder(ProductTypeChangeAttributeNameAction template)	create builder for ProductTypeChangeAttributeNameAction instance
static ProductTypeChangeAttributeNameAction	deepCopy(ProductTypeChangeAttributeNameAction template)	factory method to create a deep copy of ProductTypeChangeAttributeNameAction
@NotNull String	getAttributeName()	Name of the AttributeDefinition to update.
@NotNull String	getNewAttributeName()	New user-defined name of the Attribute that is unique with the Project.
static ProductTypeChangeAttributeNameAction	of()	factory method
static ProductTypeChangeAttributeNameAction	of(ProductTypeChangeAttributeNameAction template)	factory method to create a shallow copy ProductTypeChangeAttributeNameAction
void	setAttributeName(String attributeName)	Name of the AttributeDefinition to update.
void	setNewAttributeName(String newAttributeName)	New user-defined name of the Attribute that is unique with the Project.
static com.fasterxml.jackson.core.type.TypeReference<ProductTypeChangeAttributeNameAction>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withProductTypeChangeAttributeNameAction(Function<ProductTypeChangeAttributeNameAction,T> helper)	accessor map function

Methods inherited from interface com.commercetools.api.models.product_type.ProductTypeUpdateAction

getAction, withProductTypeUpdateAction

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

get

Field Details

CHANGE_ATTRIBUTE_NAME

static final String CHANGE_ATTRIBUTE_NAME

discriminator value for ProductTypeChangeAttributeNameAction

See Also:

• Constant Field Values

Method Details

getAttributeName

@NotNull
@NotNull String getAttributeName()

Name of the AttributeDefinition to update.

Returns:

attributeName

getNewAttributeName

@NotNull
@NotNull String getNewAttributeName()

New user-defined name of the Attribute that is unique with the Project.

When using the same name for an Attribute in two or more ProductTypes, all fields of the AttributeDefinition of this Attribute must be the same across the ProductTypes. If not, an AttributeDefinitionAlreadyExists error is returned. An exception to this are the values of an enum or lenum type and sets thereof.

Returns:

newAttributeName

setAttributeName

void setAttributeName(String attributeName)

Name of the AttributeDefinition to update.

Parameters:

attributeName - value to be set

setNewAttributeName

void setNewAttributeName(String newAttributeName)

New user-defined name of the Attribute that is unique with the Project.

When using the same name for an Attribute in two or more ProductTypes, all fields of the AttributeDefinition of this Attribute must be the same across the ProductTypes. If not, an AttributeDefinitionAlreadyExists error is returned. An exception to this are the values of an enum or lenum type and sets thereof.

Parameters:

newAttributeName - value to be set

of

static ProductTypeChangeAttributeNameAction of()

factory method

Returns:

instance of ProductTypeChangeAttributeNameAction

of

static ProductTypeChangeAttributeNameAction of(ProductTypeChangeAttributeNameAction template)

factory method to create a shallow copy ProductTypeChangeAttributeNameAction

Parameters:

template - instance to be copied

Returns:

copy instance

deepCopy

@Nullable
static ProductTypeChangeAttributeNameAction deepCopy(@Nullable
 ProductTypeChangeAttributeNameAction template)

factory method to create a deep copy of ProductTypeChangeAttributeNameAction

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static ProductTypeChangeAttributeNameActionBuilder builder()

builder factory method for ProductTypeChangeAttributeNameAction

Returns:

builder

builder

static ProductTypeChangeAttributeNameActionBuilder builder(ProductTypeChangeAttributeNameAction template)

create builder for ProductTypeChangeAttributeNameAction instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withProductTypeChangeAttributeNameAction

default <T> T withProductTypeChangeAttributeNameAction(Function<ProductTypeChangeAttributeNameAction,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<ProductTypeChangeAttributeNameAction> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference