com.squareup.sdk.reader.crm

Enum StoreCustomerCardErrorCode

java.lang.Object

java.lang.Enum<StoreCustomerCardErrorCode>

com.squareup.sdk.reader.crm.StoreCustomerCardErrorCode

All Implemented Interfaces:

ErrorCode, java.io.Serializable, java.lang.Comparable<StoreCustomerCardErrorCode>

public enum StoreCustomerCardErrorCode
extends java.lang.Enum<StoreCustomerCardErrorCode>
implements ErrorCode

Enumeration of the run-time errors that might occur when storing a card on file.

Enum Constant Summary

Enum Constants

Enum Constant and Description
CANCELED The workflow to store a card for a customer was canceled by the user backing out of the activity.
INVALID_CUSTOMER_ID The supplied customer identifier does not match any customer known to Square.
NO_NETWORK Network is not available.
SDK_NOT_AUTHORIZED Reader SDK is not currently authorized.
USAGE_ERROR A Reader SDK method was used in an unexpected or unsupported way.

Method Summary

Modifier and Type	Method and Description
boolean	isUsageError() Tests whether the error code indicates an error in usage of Reader SDK.
static StoreCustomerCardErrorCode	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static StoreCustomerCardErrorCode[]	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, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

CANCELED

public static final StoreCustomerCardErrorCode CANCELED

The workflow to store a card for a customer was canceled by the user backing out of the activity.

NO_NETWORK

public static final StoreCustomerCardErrorCode NO_NETWORK

Network is not available.

SDK_NOT_AUTHORIZED

public static final StoreCustomerCardErrorCode SDK_NOT_AUTHORIZED

Reader SDK is not currently authorized.

INVALID_CUSTOMER_ID

public static final StoreCustomerCardErrorCode INVALID_CUSTOMER_ID

The supplied customer identifier does not match any customer known to Square.

USAGE_ERROR

public static final StoreCustomerCardErrorCode USAGE_ERROR

A Reader SDK method was used in an unexpected or unsupported way. See ResultError.getDebugCode() and ResultError.getDebugMessage() for more information.

Method Detail

values

public static StoreCustomerCardErrorCode[] 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 (StoreCustomerCardErrorCode c : StoreCustomerCardErrorCode.values())
    System.out.println(c);

Returns:

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

valueOf

public static StoreCustomerCardErrorCode 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

isUsageError

public boolean isUsageError()

Tests whether the error code indicates an error in usage of Reader SDK. For example, calling Reader SDK methods outside the main thread is a usage error, but canceling checkout due to poor network conditions is not.

Specified by:

isUsageError in interface ErrorCode

Returns:

true if the error indicates a usage error, or false for run-time errors that are consistent with correct usage.