Package com.commercetools.api.models.agent

Interface GraphQLAgentOutOfScopeError

All Superinterfaces:

GraphQLErrorObject

public interface GraphQLAgentOutOfScopeError
extends GraphQLErrorObject

Returned by a /responses request when the input does not contain enough information to create the requested entity. For a Cart or Quote Request, no products, no customer email address, and no shipping country could be determined. For a Shopping List, no products, no customer email address, and no name could be determined.

Example to create an instance using the builder pattern

     GraphQLAgentOutOfScopeError graphQLAgentOutOfScopeError = GraphQLAgentOutOfScopeError.builder()
             .build()
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	OUT_OF_SCOPE	discriminator value for GraphQLAgentOutOfScopeError

Method Summary

Modifier and Type	Method	Description
static GraphQLAgentOutOfScopeErrorBuilder	builder()	builder factory method for GraphQLAgentOutOfScopeError
static GraphQLAgentOutOfScopeErrorBuilder	builder(GraphQLAgentOutOfScopeError template)	create builder for GraphQLAgentOutOfScopeError instance
GraphQLAgentOutOfScopeError	copyDeep()
static GraphQLAgentOutOfScopeError	deepCopy(GraphQLAgentOutOfScopeError template)	factory method to create a deep copy of GraphQLAgentOutOfScopeError
@NotNull String	getCode()	One of the error codes that is listed on the Errors page.
static GraphQLAgentOutOfScopeError	of()	factory method
static GraphQLAgentOutOfScopeError	of(GraphQLAgentOutOfScopeError template)	factory method to create a shallow copy GraphQLAgentOutOfScopeError
static tools.jackson.core.type.TypeReference<GraphQLAgentOutOfScopeError>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withGraphQLAgentOutOfScopeError(Function<GraphQLAgentOutOfScopeError,T> helper)	accessor map function

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

setValue, values, withGraphQLErrorObject

Field Details

OUT_OF_SCOPE

static final String OUT_OF_SCOPE

discriminator value for GraphQLAgentOutOfScopeError

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

of

static GraphQLAgentOutOfScopeError of()

factory method

Returns:

instance of GraphQLAgentOutOfScopeError

of

static GraphQLAgentOutOfScopeError of(GraphQLAgentOutOfScopeError template)

factory method to create a shallow copy GraphQLAgentOutOfScopeError

Parameters:

template - instance to be copied

Returns:

copy instance

copyDeep

GraphQLAgentOutOfScopeError copyDeep()

Specified by:

copyDeep in interface GraphQLErrorObject

deepCopy

@Nullable
static GraphQLAgentOutOfScopeError deepCopy(@Nullable
 GraphQLAgentOutOfScopeError template)

factory method to create a deep copy of GraphQLAgentOutOfScopeError

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static GraphQLAgentOutOfScopeErrorBuilder builder()

builder factory method for GraphQLAgentOutOfScopeError

Returns:

builder

builder

static GraphQLAgentOutOfScopeErrorBuilder builder(GraphQLAgentOutOfScopeError template)

create builder for GraphQLAgentOutOfScopeError instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withGraphQLAgentOutOfScopeError

default <T> T withGraphQLAgentOutOfScopeError(Function<GraphQLAgentOutOfScopeError,T> helper)

accessor map function

Type Parameters:

T - mapped type

Parameters:

helper - function to map the object

Returns:

mapped value

typeReference

static tools.jackson.core.type.TypeReference<GraphQLAgentOutOfScopeError> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference