Package com.commercetools.api.models.error

Interface InvalidOperationError

All Superinterfaces:

ErrorObject

All Known Implementing Classes:

InvalidOperationErrorImpl

public interface InvalidOperationError
extends ErrorObject

Returned when the resources involved in the request are not in a valid state for the operation.

The client application should validate the constraints described in the error message before sending the request.

Example to create an instance using the builder pattern

     InvalidOperationError invalidOperationError = InvalidOperationError.builder()
             .message("{message}")
             .build()
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	INVALID_OPERATION	discriminator value for InvalidOperationError

Method Summary

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

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

setValue, values, withErrorObject

Field Details

INVALID_OPERATION

static final String INVALID_OPERATION

discriminator value for InvalidOperationError

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 error.

Specified by:

getMessage in interface ErrorObject

Returns:

message

setMessage

void setMessage(String message)

Plain text description of the error.

Specified by:

setMessage in interface ErrorObject

Parameters:

message - value to be set

of

static InvalidOperationError of()

factory method

Returns:

instance of InvalidOperationError

of

static InvalidOperationError of(InvalidOperationError template)

factory method to create a shallow copy InvalidOperationError

Parameters:

template - instance to be copied

Returns:

copy instance

deepCopy

@Nullable
static InvalidOperationError deepCopy(@Nullable
 InvalidOperationError template)

factory method to create a deep copy of InvalidOperationError

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static InvalidOperationErrorBuilder builder()

builder factory method for InvalidOperationError

Returns:

builder

builder

static InvalidOperationErrorBuilder builder(InvalidOperationError template)

create builder for InvalidOperationError instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withInvalidOperationError

default <T> T withInvalidOperationError(Function<InvalidOperationError,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<InvalidOperationError> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference