Package com.commercetools.api.models.error

Interface NotEnabledError

All Superinterfaces:

ErrorObject

All Known Implementing Classes:

NotEnabledErrorImpl

public interface NotEnabledError
extends ErrorObject

Returned when the Project-specific category recommendations feature is not enabled for the Project.

Example to create an instance using the builder pattern

     NotEnabledError notEnabledError = NotEnabledError.builder()
             .message("{message}")
             .build()
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	NOT_ENABLED	discriminator value for NotEnabledError

Method Summary

Modifier and Type	Method	Description
static NotEnabledErrorBuilder	builder()	builder factory method for NotEnabledError
static NotEnabledErrorBuilder	builder(NotEnabledError template)	create builder for NotEnabledError instance
static NotEnabledError	deepCopy(NotEnabledError template)	factory method to create a deep copy of NotEnabledError
@NotNull String	getCode()	Error identifier.
@NotNull String	getMessage()	"The category recommendations API is not yet enabled for your project."
static NotEnabledError	of()	factory method
static NotEnabledError	of(NotEnabledError template)	factory method to create a shallow copy NotEnabledError
void	setMessage(String message)	"The category recommendations API is not yet enabled for your project."
static com.fasterxml.jackson.core.type.TypeReference<NotEnabledError>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withNotEnabledError(Function<NotEnabledError,T> helper)	accessor map function

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

setValue, values, withErrorObject

Field Details

NOT_ENABLED

static final String NOT_ENABLED

discriminator value for NotEnabledError

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

"The category recommendations API is not yet enabled for your project."

Specified by:

getMessage in interface ErrorObject

Returns:

message

setMessage

void setMessage(String message)

"The category recommendations API is not yet enabled for your project."

Specified by:

setMessage in interface ErrorObject

Parameters:

message - value to be set

of

static NotEnabledError of()

factory method

Returns:

instance of NotEnabledError

of

static NotEnabledError of(NotEnabledError template)

factory method to create a shallow copy NotEnabledError

Parameters:

template - instance to be copied

Returns:

copy instance

deepCopy

@Nullable
static NotEnabledError deepCopy(@Nullable
 NotEnabledError template)

factory method to create a deep copy of NotEnabledError

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static NotEnabledErrorBuilder builder()

builder factory method for NotEnabledError

Returns:

builder

builder

static NotEnabledErrorBuilder builder(NotEnabledError template)

create builder for NotEnabledError instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withNotEnabledError

default <T> T withNotEnabledError(Function<NotEnabledError,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<NotEnabledError> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference