com.shopify.buy3

Enum Storefront.CartErrorCode

java.lang.Object

java.lang.Enum<Storefront.CartErrorCode>

com.shopify.buy3.Storefront.CartErrorCode

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<Storefront.CartErrorCode>

Enclosing class:

Storefront

public static enum Storefront.CartErrorCode
extends java.lang.Enum<Storefront.CartErrorCode>

Possible error codes that can be returned by `CartUserError`.

Enum Constant Summary

Enum Constants

Enum Constant and Description
ADDRESS_FIELD_CONTAINS_EMOJIS The specified address field contains emojis.
ADDRESS_FIELD_CONTAINS_HTML_TAGS The specified address field contains HTML tags.
ADDRESS_FIELD_CONTAINS_URL The specified address field contains a URL.
ADDRESS_FIELD_DOES_NOT_MATCH_EXPECTED_PATTERN The specified address field does not match the expected pattern.
ADDRESS_FIELD_IS_REQUIRED The specified address field is required.
ADDRESS_FIELD_IS_TOO_LONG The specified address field is too long.
INVALID The input value is invalid.
INVALID_COMPANY_LOCATION Company location not found or not allowed.
INVALID_DELIVERY_GROUP Delivery group was not found in cart.
INVALID_DELIVERY_OPTION Delivery option was not valid.
INVALID_INCREMENT The quantity must be a multiple of the specified increment.
INVALID_MERCHANDISE_LINE Merchandise line was not found in cart.
INVALID_METAFIELDS The metafields were not valid.
INVALID_PAYMENT The payment wasn't valid.
INVALID_PAYMENT_EMPTY_CART Cannot update payment on an empty cart
INVALID_ZIP_CODE_FOR_COUNTRY The given zip code is invalid for the provided country.
INVALID_ZIP_CODE_FOR_PROVINCE The given zip code is invalid for the provided province.
LESS_THAN The input value should be less than the maximum value allowed.
MAXIMUM_EXCEEDED The quantity must be below the specified maximum for the item.
MINIMUM_NOT_MET The quantity must be above the specified minimum for the item.
MISSING_CUSTOMER_ACCESS_TOKEN The customer access token is required when setting a company location.
MISSING_DISCOUNT_CODE Missing discount code.
MISSING_NOTE Missing note.
NOTE_TOO_LONG The note length must be below the specified maximum.
PAYMENT_METHOD_NOT_SUPPORTED The payment method is not supported.
PROVINCE_NOT_FOUND The given province cannot be found.
UNKNOWN_VALUE
UNSPECIFIED_ADDRESS_ERROR A general error occurred during address validation.
VALIDATION_CUSTOM Validation failed.
ZIP_CODE_NOT_SUPPORTED The given zip code is unsupported.

Method Summary

Modifier and Type	Method and Description
static Storefront.CartErrorCode	fromGraphQl(java.lang.String value)
java.lang.String	toString()
static Storefront.CartErrorCode	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static Storefront.CartErrorCode[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

ADDRESS_FIELD_CONTAINS_EMOJIS

public static final Storefront.CartErrorCode ADDRESS_FIELD_CONTAINS_EMOJIS

The specified address field contains emojis.

ADDRESS_FIELD_CONTAINS_HTML_TAGS

public static final Storefront.CartErrorCode ADDRESS_FIELD_CONTAINS_HTML_TAGS

The specified address field contains HTML tags.

ADDRESS_FIELD_CONTAINS_URL

public static final Storefront.CartErrorCode ADDRESS_FIELD_CONTAINS_URL

The specified address field contains a URL.

ADDRESS_FIELD_DOES_NOT_MATCH_EXPECTED_PATTERN

public static final Storefront.CartErrorCode ADDRESS_FIELD_DOES_NOT_MATCH_EXPECTED_PATTERN

The specified address field does not match the expected pattern.

ADDRESS_FIELD_IS_REQUIRED

public static final Storefront.CartErrorCode ADDRESS_FIELD_IS_REQUIRED

The specified address field is required.

ADDRESS_FIELD_IS_TOO_LONG

public static final Storefront.CartErrorCode ADDRESS_FIELD_IS_TOO_LONG

The specified address field is too long.

INVALID

public static final Storefront.CartErrorCode INVALID

The input value is invalid.

INVALID_COMPANY_LOCATION

public static final Storefront.CartErrorCode INVALID_COMPANY_LOCATION

Company location not found or not allowed.

INVALID_DELIVERY_GROUP

public static final Storefront.CartErrorCode INVALID_DELIVERY_GROUP

Delivery group was not found in cart.

INVALID_DELIVERY_OPTION

public static final Storefront.CartErrorCode INVALID_DELIVERY_OPTION

Delivery option was not valid.

INVALID_INCREMENT

public static final Storefront.CartErrorCode INVALID_INCREMENT

The quantity must be a multiple of the specified increment.

INVALID_MERCHANDISE_LINE

public static final Storefront.CartErrorCode INVALID_MERCHANDISE_LINE

Merchandise line was not found in cart.

INVALID_METAFIELDS

public static final Storefront.CartErrorCode INVALID_METAFIELDS

The metafields were not valid.

INVALID_PAYMENT

public static final Storefront.CartErrorCode INVALID_PAYMENT

The payment wasn't valid.

INVALID_PAYMENT_EMPTY_CART

public static final Storefront.CartErrorCode INVALID_PAYMENT_EMPTY_CART

Cannot update payment on an empty cart

INVALID_ZIP_CODE_FOR_COUNTRY

public static final Storefront.CartErrorCode INVALID_ZIP_CODE_FOR_COUNTRY

The given zip code is invalid for the provided country.

INVALID_ZIP_CODE_FOR_PROVINCE

public static final Storefront.CartErrorCode INVALID_ZIP_CODE_FOR_PROVINCE

The given zip code is invalid for the provided province.

LESS_THAN

public static final Storefront.CartErrorCode LESS_THAN

The input value should be less than the maximum value allowed.

MAXIMUM_EXCEEDED

public static final Storefront.CartErrorCode MAXIMUM_EXCEEDED

The quantity must be below the specified maximum for the item.

MINIMUM_NOT_MET

public static final Storefront.CartErrorCode MINIMUM_NOT_MET

The quantity must be above the specified minimum for the item.

MISSING_CUSTOMER_ACCESS_TOKEN

public static final Storefront.CartErrorCode MISSING_CUSTOMER_ACCESS_TOKEN

The customer access token is required when setting a company location.

MISSING_DISCOUNT_CODE

public static final Storefront.CartErrorCode MISSING_DISCOUNT_CODE

Missing discount code.

MISSING_NOTE

public static final Storefront.CartErrorCode MISSING_NOTE

Missing note.

NOTE_TOO_LONG

public static final Storefront.CartErrorCode NOTE_TOO_LONG

The note length must be below the specified maximum.

PAYMENT_METHOD_NOT_SUPPORTED

public static final Storefront.CartErrorCode PAYMENT_METHOD_NOT_SUPPORTED

The payment method is not supported.

PROVINCE_NOT_FOUND

public static final Storefront.CartErrorCode PROVINCE_NOT_FOUND

The given province cannot be found.

UNSPECIFIED_ADDRESS_ERROR

public static final Storefront.CartErrorCode UNSPECIFIED_ADDRESS_ERROR

A general error occurred during address validation.

VALIDATION_CUSTOM

public static final Storefront.CartErrorCode VALIDATION_CUSTOM

Validation failed.

ZIP_CODE_NOT_SUPPORTED

public static final Storefront.CartErrorCode ZIP_CODE_NOT_SUPPORTED

The given zip code is unsupported.

UNKNOWN_VALUE

public static final Storefront.CartErrorCode UNKNOWN_VALUE

Method Detail

values

public static Storefront.CartErrorCode[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (Storefront.CartErrorCode c : Storefront.CartErrorCode.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static Storefront.CartErrorCode valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

fromGraphQl

public static Storefront.CartErrorCode fromGraphQl(java.lang.String value)

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Enum<Storefront.CartErrorCode>