Package com.commercetools.api.models.error

Interface InternalConstraintViolatedError

All Superinterfaces:

ErrorObject

public interface InternalConstraintViolatedError
extends ErrorObject

Returned when certain API-specific constraints were not met. For example, the specified Discount Code was never applied and cannot be updated.

Example to create an instance using the builder pattern

     InternalConstraintViolatedError internalConstraintViolatedError = InternalConstraintViolatedError.builder()
             .message("{message}")
             .build()
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	INTERNAL_CONSTRAINT_VIOLATED	discriminator value for InternalConstraintViolatedError

Method Summary

Modifier and Type	Method	Description
static InternalConstraintViolatedErrorBuilder	builder()	builder factory method for InternalConstraintViolatedError
static InternalConstraintViolatedErrorBuilder	builder(InternalConstraintViolatedError template)	create builder for InternalConstraintViolatedError instance
InternalConstraintViolatedError	copyDeep()
static InternalConstraintViolatedError	deepCopy(InternalConstraintViolatedError template)	factory method to create a deep copy of InternalConstraintViolatedError
@NotNull String	getCode()	Error identifier.
@NotNull String	getMessage()	Plain text description of the constraints that were violated.
static InternalConstraintViolatedError	of()	factory method
static InternalConstraintViolatedError	of(InternalConstraintViolatedError template)	factory method to create a shallow copy InternalConstraintViolatedError
void	setMessage(String message)	Plain text description of the constraints that were violated.
static com.fasterxml.jackson.core.type.TypeReference<InternalConstraintViolatedError>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withInternalConstraintViolatedError(Function<InternalConstraintViolatedError,T> helper)	accessor map function

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

setValue, values, withErrorObject

Field Details

INTERNAL_CONSTRAINT_VIOLATED

static final String INTERNAL_CONSTRAINT_VIOLATED

discriminator value for InternalConstraintViolatedError

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

Plain text description of the constraints that were violated.

Specified by:

getMessage in interface ErrorObject

Returns:

message

setMessage

void setMessage(String message)

Plain text description of the constraints that were violated.

Specified by:

setMessage in interface ErrorObject

Parameters:

message - value to be set

of

static InternalConstraintViolatedError of()

factory method

Returns:

instance of InternalConstraintViolatedError

of

static InternalConstraintViolatedError of(InternalConstraintViolatedError template)

factory method to create a shallow copy InternalConstraintViolatedError

Parameters:

template - instance to be copied

Returns:

copy instance

copyDeep

InternalConstraintViolatedError copyDeep()

Specified by:

copyDeep in interface ErrorObject

deepCopy

@Nullable
static InternalConstraintViolatedError deepCopy(@Nullable
 InternalConstraintViolatedError template)

factory method to create a deep copy of InternalConstraintViolatedError

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static InternalConstraintViolatedErrorBuilder builder()

builder factory method for InternalConstraintViolatedError

Returns:

builder

builder

static InternalConstraintViolatedErrorBuilder builder(InternalConstraintViolatedError template)

create builder for InternalConstraintViolatedError instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withInternalConstraintViolatedError

default <T> T withInternalConstraintViolatedError(Function<InternalConstraintViolatedError,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<InternalConstraintViolatedError> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference