Package com.commercetools.api.models.error

Interface CountryNotConfiguredInStoreError

All Superinterfaces:

ErrorObject

public interface CountryNotConfiguredInStoreError
extends ErrorObject

Returned when a Cart or an Order in a Store references a country that is not included in the countries configured for the Store.

The error is returned as a failed response to:

• Create Cart in Store request and Set Country update action on Carts.
• Create Cart in Store request and Set Country update action on My Carts.
• Create Order in Store from Cart and Create Order from Quote requests on Orders.
• Create Order in Store from Cart and Create Order from Quote requests on My Orders.
• Create Order by Import request on Order Import.
• Set Country update action on Order Edits.

Example to create an instance using the builder pattern

     CountryNotConfiguredInStoreError countryNotConfiguredInStoreError = CountryNotConfiguredInStoreError.builder()
             .message("{message}")
             .plusStoreCountries(storeCountriesBuilder -> storeCountriesBuilder)
             .country("{country}")
             .build()
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	COUNTRY_NOT_CONFIGURED_IN_STORE	discriminator value for CountryNotConfiguredInStoreError

Method Summary

Modifier and Type	Method	Description
static CountryNotConfiguredInStoreErrorBuilder	builder()	builder factory method for CountryNotConfiguredInStoreError
static CountryNotConfiguredInStoreErrorBuilder	builder(CountryNotConfiguredInStoreError template)	create builder for CountryNotConfiguredInStoreError instance
CountryNotConfiguredInStoreError	copyDeep()
static CountryNotConfiguredInStoreError	deepCopy(CountryNotConfiguredInStoreError template)	factory method to create a deep copy of CountryNotConfiguredInStoreError
@NotNull String	getCode()	Error identifier.
@NotNull String	getCountry()	The country that is not configured for the Store but referenced on the Cart or Order.
@NotNull String	getMessage()	"The country $country is not configured for the store $store."
@NotNull List<String>	getStoreCountries()	Countries configured for the Store.
static CountryNotConfiguredInStoreError	of()	factory method
static CountryNotConfiguredInStoreError	of(CountryNotConfiguredInStoreError template)	factory method to create a shallow copy CountryNotConfiguredInStoreError
void	setCountry(String country)	The country that is not configured for the Store but referenced on the Cart or Order.
void	setMessage(String message)	"The country $country is not configured for the store $store."
void	setStoreCountries(String... storeCountries)	Countries configured for the Store.
void	setStoreCountries(List<String> storeCountries)	Countries configured for the Store.
static com.fasterxml.jackson.core.type.TypeReference<CountryNotConfiguredInStoreError>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withCountryNotConfiguredInStoreError(Function<CountryNotConfiguredInStoreError,T> helper)	accessor map function

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

setValue, values, withErrorObject

Field Details

COUNTRY_NOT_CONFIGURED_IN_STORE

static final String COUNTRY_NOT_CONFIGURED_IN_STORE

discriminator value for CountryNotConfiguredInStoreError

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 country $country is not configured for the store $store."

Specified by:

getMessage in interface ErrorObject

Returns:

message

getStoreCountries

@NotNull
@NotNull List<String> getStoreCountries()

Countries configured for the Store.

Returns:

storeCountries

getCountry

@NotNull
@NotNull String getCountry()

The country that is not configured for the Store but referenced on the Cart or Order.

Returns:

country

setMessage

void setMessage(String message)

"The country $country is not configured for the store $store."

Specified by:

setMessage in interface ErrorObject

Parameters:

message - value to be set

setStoreCountries

void setStoreCountries(String... storeCountries)

Countries configured for the Store.

Parameters:

storeCountries - values to be set

setStoreCountries

void setStoreCountries(List<String> storeCountries)

Countries configured for the Store.

Parameters:

storeCountries - values to be set

setCountry

void setCountry(String country)

The country that is not configured for the Store but referenced on the Cart or Order.

Parameters:

country - value to be set

of

static CountryNotConfiguredInStoreError of()

factory method

Returns:

instance of CountryNotConfiguredInStoreError

of

static CountryNotConfiguredInStoreError of(CountryNotConfiguredInStoreError template)

factory method to create a shallow copy CountryNotConfiguredInStoreError

Parameters:

template - instance to be copied

Returns:

copy instance

copyDeep

CountryNotConfiguredInStoreError copyDeep()

Specified by:

copyDeep in interface ErrorObject

deepCopy

@Nullable
static CountryNotConfiguredInStoreError deepCopy(@Nullable
 CountryNotConfiguredInStoreError template)

factory method to create a deep copy of CountryNotConfiguredInStoreError

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static CountryNotConfiguredInStoreErrorBuilder builder()

builder factory method for CountryNotConfiguredInStoreError

Returns:

builder

builder

static CountryNotConfiguredInStoreErrorBuilder builder(CountryNotConfiguredInStoreError template)

create builder for CountryNotConfiguredInStoreError instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withCountryNotConfiguredInStoreError

default <T> T withCountryNotConfiguredInStoreError(Function<CountryNotConfiguredInStoreError,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<CountryNotConfiguredInStoreError> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference