Package org.codelibs.fess.app.web.api

Enum Class ApiResult.Status

java.lang.Object

java.lang.Enum<ApiResult.Status>

org.codelibs.fess.app.web.api.ApiResult.Status

All Implemented Interfaces:

Serializable, Comparable<ApiResult.Status>, Constable

Enclosing class:

ApiResult

public static enum ApiResult.Status
extends Enum<ApiResult.Status>

Represents the status of an API response.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
BAD_REQUEST	Bad request status indicating client error.
FAILED	General failure status.
OK	Successful response status.
SYSTEM_ERROR	System error status indicating server error.
UNAUTHORIZED	Unauthorized status indicating authentication failure.

Method Summary

Modifier and Type	Method	Description
int	getId()	Gets the numeric ID of the status.
static ApiResult.Status	valueOf(String name)	Returns the enum constant of this class with the specified name.
static ApiResult.Status[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

OK

public static final ApiResult.Status OK

Successful response status.

BAD_REQUEST

public static final ApiResult.Status BAD_REQUEST

Bad request status indicating client error.

SYSTEM_ERROR

public static final ApiResult.Status SYSTEM_ERROR

System error status indicating server error.

UNAUTHORIZED

public static final ApiResult.Status UNAUTHORIZED

Unauthorized status indicating authentication failure.

FAILED

public static final ApiResult.Status FAILED

General failure status.

Method Details

values

public static ApiResult.Status[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static ApiResult.Status valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null

getId

public int getId()

Gets the numeric ID of the status.

Returns:

The numeric ID of the status.