Package com.commercetools.api.models.error

Interface GraphQLOutOfStockError

All Superinterfaces:

GraphQLErrorObject

public interface GraphQLOutOfStockError
extends GraphQLErrorObject

Returned when some of the Line Items are out of stock at the time of placing an Order.

The error is returned as a failed response to:

• Create Order from Cart, Create Order in Store from Cart, Create Order from Quote, and Create Order by Import requests on Orders.
• Create Order from Cart, Create Order in Store from Cart, and Create Order from Quote requests on My Orders.
• Create Order from Cart in BusinessUnit and Create Order from Quote in BusinessUnit requests on Associate Orders.

Example to create an instance using the builder pattern

     GraphQLOutOfStockError graphQLOutOfStockError = GraphQLOutOfStockError.builder()
             .plusLineItems(lineItemsBuilder -> lineItemsBuilder)
             .plusSkus(skusBuilder -> skusBuilder)
             .build()
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	OUT_OF_STOCK	discriminator value for GraphQLOutOfStockError

Method Summary

Modifier and Type	Method	Description
static GraphQLOutOfStockErrorBuilder	builder()	builder factory method for GraphQLOutOfStockError
static GraphQLOutOfStockErrorBuilder	builder(GraphQLOutOfStockError template)	create builder for GraphQLOutOfStockError instance
GraphQLOutOfStockError	copyDeep()
static GraphQLOutOfStockError	deepCopy(GraphQLOutOfStockError template)	factory method to create a deep copy of GraphQLOutOfStockError
@NotNull String	getCode()	One of the error codes that is listed on the Errors page.
@NotNull List<String>	getLineItems()	Unique identifiers of the Line Items that are out of stock.
@NotNull List<String>	getSkus()	SKUs of the Line Items that are out of stock.
static GraphQLOutOfStockError	of()	factory method
static GraphQLOutOfStockError	of(GraphQLOutOfStockError template)	factory method to create a shallow copy GraphQLOutOfStockError
void	setLineItems(String... lineItems)	Unique identifiers of the Line Items that are out of stock.
void	setLineItems(List<String> lineItems)	Unique identifiers of the Line Items that are out of stock.
void	setSkus(String... skus)	SKUs of the Line Items that are out of stock.
void	setSkus(List<String> skus)	SKUs of the Line Items that are out of stock.
static com.fasterxml.jackson.core.type.TypeReference<GraphQLOutOfStockError>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withGraphQLOutOfStockError(Function<GraphQLOutOfStockError,T> helper)	accessor map function

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

setValue, values, withGraphQLErrorObject

Field Details

OUT_OF_STOCK

static final String OUT_OF_STOCK

discriminator value for GraphQLOutOfStockError

See Also:

• Constant Field Values

Method Details

getCode

@NotNull
@NotNull String getCode()

Description copied from interface: GraphQLErrorObject

One of the error codes that is listed on the Errors page.

Specified by:

getCode in interface GraphQLErrorObject

Returns:

code

getLineItems

@NotNull
@NotNull List<String> getLineItems()

Unique identifiers of the Line Items that are out of stock.

Returns:

lineItems

getSkus

@NotNull
@NotNull List<String> getSkus()

SKUs of the Line Items that are out of stock.

Returns:

skus

setLineItems

void setLineItems(String... lineItems)

Unique identifiers of the Line Items that are out of stock.

Parameters:

lineItems - values to be set

setLineItems

void setLineItems(List<String> lineItems)

Unique identifiers of the Line Items that are out of stock.

Parameters:

lineItems - values to be set

setSkus

void setSkus(String... skus)

SKUs of the Line Items that are out of stock.

Parameters:

skus - values to be set

setSkus

void setSkus(List<String> skus)

SKUs of the Line Items that are out of stock.

Parameters:

skus - values to be set

of

static GraphQLOutOfStockError of()

factory method

Returns:

instance of GraphQLOutOfStockError

of

static GraphQLOutOfStockError of(GraphQLOutOfStockError template)

factory method to create a shallow copy GraphQLOutOfStockError

Parameters:

template - instance to be copied

Returns:

copy instance

copyDeep

GraphQLOutOfStockError copyDeep()

Specified by:

copyDeep in interface GraphQLErrorObject

deepCopy

@Nullable
static GraphQLOutOfStockError deepCopy(@Nullable
 GraphQLOutOfStockError template)

factory method to create a deep copy of GraphQLOutOfStockError

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static GraphQLOutOfStockErrorBuilder builder()

builder factory method for GraphQLOutOfStockError

Returns:

builder

builder

static GraphQLOutOfStockErrorBuilder builder(GraphQLOutOfStockError template)

create builder for GraphQLOutOfStockError instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withGraphQLOutOfStockError

default <T> T withGraphQLOutOfStockError(Function<GraphQLOutOfStockError,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<GraphQLOutOfStockError> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference