net.hrider.api

Enum ApiError.Code

java.lang.Object

java.lang.Enum<ApiError.Code>

net.hrider.api.ApiError.Code

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<ApiError.Code>

Enclosing class:

ApiError

public static enum ApiError.Code
extends java.lang.Enum<ApiError.Code>

API error codes.

Enum Constant Summary

Enum Constants

Enum Constant and Description
E001 Object doesn't exist.
E002 Not authorized.
E003 Request invalid.
E004 Upload exceeds maximum size.
E005 Conflict (e.g. another employee exists with this external-id)
E006 URL endpoint doesn't exist
E007 Method not allowed
E008 Not acceptable
E999 Unknown error.

Method Summary

Modifier and Type	Method and Description
static ApiError.Code	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static ApiError.Code[]	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

E001

public static final ApiError.Code E001

Object doesn't exist.

E002

public static final ApiError.Code E002

Not authorized.

E003

public static final ApiError.Code E003

Request invalid.

E004

public static final ApiError.Code E004

Upload exceeds maximum size.

E005

public static final ApiError.Code E005

Conflict (e.g. another employee exists with this external-id)

E006

public static final ApiError.Code E006

URL endpoint doesn't exist

E007

public static final ApiError.Code E007

Method not allowed

E008

public static final ApiError.Code E008

Not acceptable

E999

public static final ApiError.Code E999

Unknown error.

Method Detail

values

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

Returns:

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

valueOf

public static ApiError.Code 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