org.forgerock.openam.scripting

Enum ScriptConstants.ScriptErrorCode

java.lang.Object

java.lang.Enum<ScriptConstants.ScriptErrorCode>

org.forgerock.openam.scripting.ScriptConstants.ScriptErrorCode

All Implemented Interfaces:

Serializable, Comparable<ScriptConstants.ScriptErrorCode>

Enclosing class:

ScriptConstants

public static enum ScriptConstants.ScriptErrorCode
extends Enum<ScriptConstants.ScriptErrorCode>

Error messages are stored in the scripting.properties file to facilitate translation. Each entry in this enum corresponds to a specific error message in the file keyed on the code.

Enum Constant Summary

Enum Constants

Enum Constant and Description
CONTEXT_NOT_RECOGNISED
DELETE_FAILED
DELETING_DEFAULT_SCRIPT
DELETING_SCRIPT_IN_USE_PLURAL
DELETING_SCRIPT_IN_USE_SINGULAR
FILTER_BOOLEAN_LITERAL_FALSE
FILTER_EXTENDED_MATCH
FILTER_GREATER_THAN
FILTER_GREATER_THAN_OR_EQUAL
FILTER_LESS_THAN
FILTER_LESS_THAN_OR_EQUAL
FILTER_NOT
FILTER_PRESENT
FIND_BY_NAME_FAILED
FIND_BY_UUID_FAILED
INSUFFICIENT_PRIVILEGES
LANGUAGE_NOT_SUPPORTED
MISSING_SCRIPT
MISSING_SCRIPT_CONTEXT
MISSING_SCRIPT_NAME
MISSING_SCRIPT_UUID
MISSING_SCRIPTING_LANGUAGE
RESOURCE_FILTER_NOT_SUPPORTED
RETRIEVE_ALL_FAILED
RETRIEVE_FAILED
SAVE_FAILED
SCRIPT_DECODING_FAILED
SCRIPT_NAME_EXISTS
SCRIPT_UUID_EXISTS
SCRIPT_UUID_NOT_FOUND

Method Summary

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

CONTEXT_NOT_RECOGNISED

public static final ScriptConstants.ScriptErrorCode CONTEXT_NOT_RECOGNISED

LANGUAGE_NOT_SUPPORTED

public static final ScriptConstants.ScriptErrorCode LANGUAGE_NOT_SUPPORTED

FIND_BY_NAME_FAILED

public static final ScriptConstants.ScriptErrorCode FIND_BY_NAME_FAILED

FIND_BY_UUID_FAILED

public static final ScriptConstants.ScriptErrorCode FIND_BY_UUID_FAILED

DELETE_FAILED

public static final ScriptConstants.ScriptErrorCode DELETE_FAILED

RETRIEVE_FAILED

public static final ScriptConstants.ScriptErrorCode RETRIEVE_FAILED

RETRIEVE_ALL_FAILED

public static final ScriptConstants.ScriptErrorCode RETRIEVE_ALL_FAILED

SAVE_FAILED

public static final ScriptConstants.ScriptErrorCode SAVE_FAILED

MISSING_SCRIPT_UUID

public static final ScriptConstants.ScriptErrorCode MISSING_SCRIPT_UUID

MISSING_SCRIPT_NAME

public static final ScriptConstants.ScriptErrorCode MISSING_SCRIPT_NAME

MISSING_SCRIPT

public static final ScriptConstants.ScriptErrorCode MISSING_SCRIPT

MISSING_SCRIPTING_LANGUAGE

public static final ScriptConstants.ScriptErrorCode MISSING_SCRIPTING_LANGUAGE

MISSING_SCRIPT_CONTEXT

public static final ScriptConstants.ScriptErrorCode MISSING_SCRIPT_CONTEXT

SCRIPT_NAME_EXISTS

public static final ScriptConstants.ScriptErrorCode SCRIPT_NAME_EXISTS

SCRIPT_UUID_EXISTS

public static final ScriptConstants.ScriptErrorCode SCRIPT_UUID_EXISTS

SCRIPT_UUID_NOT_FOUND

public static final ScriptConstants.ScriptErrorCode SCRIPT_UUID_NOT_FOUND

FILTER_BOOLEAN_LITERAL_FALSE

public static final ScriptConstants.ScriptErrorCode FILTER_BOOLEAN_LITERAL_FALSE

FILTER_EXTENDED_MATCH

public static final ScriptConstants.ScriptErrorCode FILTER_EXTENDED_MATCH

FILTER_GREATER_THAN

public static final ScriptConstants.ScriptErrorCode FILTER_GREATER_THAN

FILTER_GREATER_THAN_OR_EQUAL

public static final ScriptConstants.ScriptErrorCode FILTER_GREATER_THAN_OR_EQUAL

FILTER_LESS_THAN

public static final ScriptConstants.ScriptErrorCode FILTER_LESS_THAN

FILTER_LESS_THAN_OR_EQUAL

public static final ScriptConstants.ScriptErrorCode FILTER_LESS_THAN_OR_EQUAL

FILTER_NOT

public static final ScriptConstants.ScriptErrorCode FILTER_NOT

FILTER_PRESENT

public static final ScriptConstants.ScriptErrorCode FILTER_PRESENT

RESOURCE_FILTER_NOT_SUPPORTED

public static final ScriptConstants.ScriptErrorCode RESOURCE_FILTER_NOT_SUPPORTED

SCRIPT_DECODING_FAILED

public static final ScriptConstants.ScriptErrorCode SCRIPT_DECODING_FAILED

DELETING_DEFAULT_SCRIPT

public static final ScriptConstants.ScriptErrorCode DELETING_DEFAULT_SCRIPT

DELETING_SCRIPT_IN_USE_SINGULAR

public static final ScriptConstants.ScriptErrorCode DELETING_SCRIPT_IN_USE_SINGULAR

DELETING_SCRIPT_IN_USE_PLURAL

public static final ScriptConstants.ScriptErrorCode DELETING_SCRIPT_IN_USE_PLURAL

INSUFFICIENT_PRIVILEGES

public static final ScriptConstants.ScriptErrorCode INSUFFICIENT_PRIVILEGES

Method Detail

values

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

Returns:

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

valueOf

public static ScriptConstants.ScriptErrorCode 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