Package com.commercetools.api.models.error

Interface AttributeDefinitionAlreadyExistsError

All Superinterfaces:

ErrorObject

All Known Implementing Classes:

AttributeDefinitionAlreadyExistsErrorImpl

public interface AttributeDefinitionAlreadyExistsError
extends ErrorObject

Returned when the name of the AttributeDefinition conflicts with an existing Attribute.

The error is returned as a failed response to the Create ProductType request or Change AttributeDefinition Name update action.

Example to create an instance using the builder pattern

     AttributeDefinitionAlreadyExistsError attributeDefinitionAlreadyExistsError = AttributeDefinitionAlreadyExistsError.builder()
             .message("{message}")
             .conflictingProductTypeId("{conflictingProductTypeId}")
             .conflictingProductTypeName("{conflictingProductTypeName}")
             .conflictingAttributeName("{conflictingAttributeName}")
             .build()
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ATTRIBUTE_DEFINITION_ALREADY_EXISTS	discriminator value for AttributeDefinitionAlreadyExistsError

Method Summary

Modifier and Type	Method	Description
static AttributeDefinitionAlreadyExistsErrorBuilder	builder()	builder factory method for AttributeDefinitionAlreadyExistsError
static AttributeDefinitionAlreadyExistsErrorBuilder	builder(AttributeDefinitionAlreadyExistsError template)	create builder for AttributeDefinitionAlreadyExistsError instance
static AttributeDefinitionAlreadyExistsError	deepCopy(AttributeDefinitionAlreadyExistsError template)	factory method to create a deep copy of AttributeDefinitionAlreadyExistsError
@NotNull String	getCode()	Error identifier.
@NotNull String	getConflictingAttributeName()	Name of the conflicting Attribute.
@NotNull String	getConflictingProductTypeId()	Unique identifier of the Product Type containing the conflicting name.
@NotNull String	getConflictingProductTypeName()	Name of the Product Type containing the conflicting name.
@NotNull String	getMessage()	"An attribute definition with name $attributeName already exists on product type $productTypeName."
static AttributeDefinitionAlreadyExistsError	of()	factory method
static AttributeDefinitionAlreadyExistsError	of(AttributeDefinitionAlreadyExistsError template)	factory method to create a shallow copy AttributeDefinitionAlreadyExistsError
void	setConflictingAttributeName(String conflictingAttributeName)	Name of the conflicting Attribute.
void	setConflictingProductTypeId(String conflictingProductTypeId)	Unique identifier of the Product Type containing the conflicting name.
void	setConflictingProductTypeName(String conflictingProductTypeName)	Name of the Product Type containing the conflicting name.
void	setMessage(String message)	"An attribute definition with name $attributeName already exists on product type $productTypeName."
static com.fasterxml.jackson.core.type.TypeReference<AttributeDefinitionAlreadyExistsError>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withAttributeDefinitionAlreadyExistsError(Function<AttributeDefinitionAlreadyExistsError,T> helper)	accessor map function

Methods inherited from interface com.commercetools.api.models.error.ErrorObject

setValue, values, withErrorObject

Field Details

ATTRIBUTE_DEFINITION_ALREADY_EXISTS

static final String ATTRIBUTE_DEFINITION_ALREADY_EXISTS

discriminator value for AttributeDefinitionAlreadyExistsError

See Also:

• Constant Field Values

Method Details

getCode

@NotNull
@NotNull String getCode()

Description copied from interface: ErrorObject

Error identifier.

Specified by:

getCode in interface ErrorObject

Returns:

code

getMessage

@NotNull
@NotNull String getMessage()

"An attribute definition with name $attributeName already exists on product type $productTypeName."

Specified by:

getMessage in interface ErrorObject

Returns:

message

getConflictingProductTypeId

@NotNull
@NotNull String getConflictingProductTypeId()

Unique identifier of the Product Type containing the conflicting name.

Returns:

conflictingProductTypeId

getConflictingProductTypeName

@NotNull
@NotNull String getConflictingProductTypeName()

Name of the Product Type containing the conflicting name.

Returns:

conflictingProductTypeName

getConflictingAttributeName

@NotNull
@NotNull String getConflictingAttributeName()

Name of the conflicting Attribute.

Returns:

conflictingAttributeName

setMessage

void setMessage(String message)

"An attribute definition with name $attributeName already exists on product type $productTypeName."

Specified by:

setMessage in interface ErrorObject

Parameters:

message - value to be set

setConflictingProductTypeId

void setConflictingProductTypeId(String conflictingProductTypeId)

Unique identifier of the Product Type containing the conflicting name.

Parameters:

conflictingProductTypeId - value to be set

setConflictingProductTypeName

void setConflictingProductTypeName(String conflictingProductTypeName)

Name of the Product Type containing the conflicting name.

Parameters:

conflictingProductTypeName - value to be set

setConflictingAttributeName

void setConflictingAttributeName(String conflictingAttributeName)

Name of the conflicting Attribute.

Parameters:

conflictingAttributeName - value to be set

of

static AttributeDefinitionAlreadyExistsError of()

factory method

Returns:

instance of AttributeDefinitionAlreadyExistsError

of

static AttributeDefinitionAlreadyExistsError of(AttributeDefinitionAlreadyExistsError template)

factory method to create a shallow copy AttributeDefinitionAlreadyExistsError

Parameters:

template - instance to be copied

Returns:

copy instance

deepCopy

@Nullable
static AttributeDefinitionAlreadyExistsError deepCopy(@Nullable
 AttributeDefinitionAlreadyExistsError template)

factory method to create a deep copy of AttributeDefinitionAlreadyExistsError

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static AttributeDefinitionAlreadyExistsErrorBuilder builder()

builder factory method for AttributeDefinitionAlreadyExistsError

Returns:

builder

builder

static AttributeDefinitionAlreadyExistsErrorBuilder builder(AttributeDefinitionAlreadyExistsError template)

create builder for AttributeDefinitionAlreadyExistsError instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withAttributeDefinitionAlreadyExistsError

default <T> T withAttributeDefinitionAlreadyExistsError(Function<AttributeDefinitionAlreadyExistsError,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<AttributeDefinitionAlreadyExistsError> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference