Package com.commercetools.api.models.error

Interface GraphQLEditPreviewFailedError

All Superinterfaces:

GraphQLErrorObject

public interface GraphQLEditPreviewFailedError
extends GraphQLErrorObject

Returned when a preview to find an appropriate Shipping Method for an OrderEdit could not be generated.

The error is returned as a failed response to the Get Shipping Methods for an OrderEdit request.

Example to create an instance using the builder pattern

     GraphQLEditPreviewFailedError graphQLEditPreviewFailedError = GraphQLEditPreviewFailedError.builder()
             .result(resultBuilder -> resultBuilder)
             .build()
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	EDIT_PREVIEW_FAILED	discriminator value for GraphQLEditPreviewFailedError

Method Summary

Modifier and Type	Method	Description
static GraphQLEditPreviewFailedErrorBuilder	builder()	builder factory method for GraphQLEditPreviewFailedError
static GraphQLEditPreviewFailedErrorBuilder	builder(GraphQLEditPreviewFailedError template)	create builder for GraphQLEditPreviewFailedError instance
GraphQLEditPreviewFailedError	copyDeep()
static GraphQLEditPreviewFailedError	deepCopy(GraphQLEditPreviewFailedError template)	factory method to create a deep copy of GraphQLEditPreviewFailedError
@NotNull String	getCode()	One of the error codes that is listed on the Errors page.
@NotNull @Valid OrderEditPreviewFailure	getResult()	State of the OrderEdit where the stagedActions cannot be applied to the Order.
static GraphQLEditPreviewFailedError	of()	factory method
static GraphQLEditPreviewFailedError	of(GraphQLEditPreviewFailedError template)	factory method to create a shallow copy GraphQLEditPreviewFailedError
void	setResult(OrderEditPreviewFailure result)	State of the OrderEdit where the stagedActions cannot be applied to the Order.
static com.fasterxml.jackson.core.type.TypeReference<GraphQLEditPreviewFailedError>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withGraphQLEditPreviewFailedError(Function<GraphQLEditPreviewFailedError,T> helper)	accessor map function

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

setValue, values, withGraphQLErrorObject

Field Details

EDIT_PREVIEW_FAILED

static final String EDIT_PREVIEW_FAILED

discriminator value for GraphQLEditPreviewFailedError

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

getResult

@NotNull
@Valid
@NotNull @Valid OrderEditPreviewFailure getResult()

State of the OrderEdit where the stagedActions cannot be applied to the Order.

Returns:

result

setResult

void setResult(OrderEditPreviewFailure result)

State of the OrderEdit where the stagedActions cannot be applied to the Order.

Parameters:

result - value to be set

of

static GraphQLEditPreviewFailedError of()

factory method

Returns:

instance of GraphQLEditPreviewFailedError

of

static GraphQLEditPreviewFailedError of(GraphQLEditPreviewFailedError template)

factory method to create a shallow copy GraphQLEditPreviewFailedError

Parameters:

template - instance to be copied

Returns:

copy instance

copyDeep

GraphQLEditPreviewFailedError copyDeep()

Specified by:

copyDeep in interface GraphQLErrorObject

deepCopy

@Nullable
static GraphQLEditPreviewFailedError deepCopy(@Nullable
 GraphQLEditPreviewFailedError template)

factory method to create a deep copy of GraphQLEditPreviewFailedError

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static GraphQLEditPreviewFailedErrorBuilder builder()

builder factory method for GraphQLEditPreviewFailedError

Returns:

builder

builder

static GraphQLEditPreviewFailedErrorBuilder builder(GraphQLEditPreviewFailedError template)

create builder for GraphQLEditPreviewFailedError instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withGraphQLEditPreviewFailedError

default <T> T withGraphQLEditPreviewFailedError(Function<GraphQLEditPreviewFailedError,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<GraphQLEditPreviewFailedError> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference