Package com.commercetools.api.models.error

Interface MaxStoreReferencesReachedError

All Superinterfaces:

ErrorObject

public interface MaxStoreReferencesReachedError
extends ErrorObject

Returned when a Store cannot be added to a Cart Discount as the limit for Stores configured for a Cart Discount has been reached.

The error is returned as a failed response to:

• Create CartDiscount and Create CartDiscount in Store requests
• Add Store and Set Store update actions

Example to create an instance using the builder pattern

     MaxStoreReferencesReachedError maxStoreReferencesReachedError = MaxStoreReferencesReachedError.builder()
             .message("{message}")
             .build()
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	MAX_STORE_REFERENCES_REACHED	discriminator value for MaxStoreReferencesReachedError

Method Summary

Modifier and Type	Method	Description
static MaxStoreReferencesReachedErrorBuilder	builder()	builder factory method for MaxStoreReferencesReachedError
static MaxStoreReferencesReachedErrorBuilder	builder(MaxStoreReferencesReachedError template)	create builder for MaxStoreReferencesReachedError instance
MaxStoreReferencesReachedError	copyDeep()
static MaxStoreReferencesReachedError	deepCopy(MaxStoreReferencesReachedError template)	factory method to create a deep copy of MaxStoreReferencesReachedError
@NotNull String	getCode()	Error identifier.
@NotNull String	getMessage()	"Maximum number of store discounts on a single cart discount reached $max".
static MaxStoreReferencesReachedError	of()	factory method
static MaxStoreReferencesReachedError	of(MaxStoreReferencesReachedError template)	factory method to create a shallow copy MaxStoreReferencesReachedError
void	setMessage(String message)	"Maximum number of store discounts on a single cart discount reached $max".
static com.fasterxml.jackson.core.type.TypeReference<MaxStoreReferencesReachedError>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withMaxStoreReferencesReachedError(Function<MaxStoreReferencesReachedError,T> helper)	accessor map function

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

setValue, values, withErrorObject

Field Details

MAX_STORE_REFERENCES_REACHED

static final String MAX_STORE_REFERENCES_REACHED

discriminator value for MaxStoreReferencesReachedError

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

"Maximum number of store discounts on a single cart discount reached $max".

Specified by:

getMessage in interface ErrorObject

Returns:

message

setMessage

void setMessage(String message)

"Maximum number of store discounts on a single cart discount reached $max".

Specified by:

setMessage in interface ErrorObject

Parameters:

message - value to be set

of

static MaxStoreReferencesReachedError of()

factory method

Returns:

instance of MaxStoreReferencesReachedError

of

static MaxStoreReferencesReachedError of(MaxStoreReferencesReachedError template)

factory method to create a shallow copy MaxStoreReferencesReachedError

Parameters:

template - instance to be copied

Returns:

copy instance

copyDeep

MaxStoreReferencesReachedError copyDeep()

Specified by:

copyDeep in interface ErrorObject

deepCopy

@Nullable
static MaxStoreReferencesReachedError deepCopy(@Nullable
 MaxStoreReferencesReachedError template)

factory method to create a deep copy of MaxStoreReferencesReachedError

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static MaxStoreReferencesReachedErrorBuilder builder()

builder factory method for MaxStoreReferencesReachedError

Returns:

builder

builder

static MaxStoreReferencesReachedErrorBuilder builder(MaxStoreReferencesReachedError template)

create builder for MaxStoreReferencesReachedError instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withMaxStoreReferencesReachedError

default <T> T withMaxStoreReferencesReachedError(Function<MaxStoreReferencesReachedError,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<MaxStoreReferencesReachedError> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference