com.gentics.contentnode.rest.model.response

Enum ResponseCode

java.lang.Object

java.lang.Enum<ResponseCode>

com.gentics.contentnode.rest.model.response.ResponseCode

All Implemented Interfaces:

Serializable, Comparable<ResponseCode>

public enum ResponseCode
extends Enum<ResponseCode>

Response codes that are returned to the client as answers for requests.

Author:

floriangutmann

Enum Constant Summary

Enum Constants

Enum Constant and Description
AUTHREQUIRED Used if a request was made with missing or invalid session identification
FAILURE Used if something unexpected went wrong (eg.
INVALIDDATA Used if the request was made with invalid (insufficient) data
LOCKED The requested update could be done, because the object was locked by another user
MAINTENANCEMODE Used if the maintenancemode was enabled
NOTFOUND Used if the requested object was not found
NOTLICENSED Used if a request was made to a resource that required additional licensing
OK Used if everything went ok (eg.
PERMISSION Used if insufficient permissions permitted to requested action

Method Summary

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

OK

public static final ResponseCode OK

Used if everything went ok (eg. page successfully saved)

INVALIDDATA

public static final ResponseCode INVALIDDATA

Used if the request was made with invalid (insufficient) data

PERMISSION

public static final ResponseCode PERMISSION

Used if insufficient permissions permitted to requested action

MAINTENANCEMODE

public static final ResponseCode MAINTENANCEMODE

Used if the maintenancemode was enabled

NOTFOUND

public static final ResponseCode NOTFOUND

Used if the requested object was not found

FAILURE

public static final ResponseCode FAILURE

Used if something unexpected went wrong (eg. page couldn't be successfully saved due to a database error)

AUTHREQUIRED

public static final ResponseCode AUTHREQUIRED

Used if a request was made with missing or invalid session identification

NOTLICENSED

public static final ResponseCode NOTLICENSED

Used if a request was made to a resource that required additional licensing

LOCKED

public static final ResponseCode LOCKED

The requested update could be done, because the object was locked by another user

Method Detail

values

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

Returns:

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

valueOf

public static ResponseCode valueOf(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:

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

NullPointerException - if the argument is null