Skip navigation links

oracle.webcenter.search
Enum SearchExceptionCodes

java.lang.Object
java.lang.Enum<SearchExceptionCodes>
oracle.webcenter.search.SearchExceptionCodes

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<SearchExceptionCodes>, SearchExceptionCode

public enum SearchExceptionCodes

extends java.lang.Enum<SearchExceptionCodes>

implements SearchExceptionCode

This enumeration lists the possible value for the SearchExceptionCodes that comes with the API. There will be messages corresponding to these keys in the SearchResourceBundle class.

Since:

11.1.1.0.0 Beta 2

Enum Constant Summary

AUTHENTICATION_ERROR
An error occurred with authentication that halted execution.

CONFIGURATION_ERROR
Configuration related errors.

EXECUTION_ERROR
An error occurred while executing the Query.

INVALID_QUERY
Any part of the Query that is sent in is invalid.

RESPONSE_ERROR
An error occurred with the QueryResult sent back.

SEARCH_API_IMPLEMENTATION_ERROR
An error occurred when api implementation does not provide expected data

Method Summary

java.lang.String	getResourceBundleKey() Gets the key in the resource bundle for the exception code.
static SearchExceptionCodes	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static SearchExceptionCodes[]	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

CONFIGURATION_ERROR

public static final SearchExceptionCodes CONFIGURATION_ERROR

Configuration related errors.

INVALID_QUERY

public static final SearchExceptionCodes INVALID_QUERY

Any part of the Query that is sent in is invalid.

EXECUTION_ERROR

public static final SearchExceptionCodes EXECUTION_ERROR

An error occurred while executing the Query.

RESPONSE_ERROR

public static final SearchExceptionCodes RESPONSE_ERROR

An error occurred with the QueryResult sent back.

AUTHENTICATION_ERROR

public static final SearchExceptionCodes AUTHENTICATION_ERROR

An error occurred with authentication that halted execution.

SEARCH_API_IMPLEMENTATION_ERROR

public static final SearchExceptionCodes SEARCH_API_IMPLEMENTATION_ERROR

An error occurred when api implementation does not provide expected data

Method Detail

values

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

Returns:

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

valueOf

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

getResourceBundleKey

public java.lang.String getResourceBundleKey()

Gets the key in the resource bundle for the exception code.

Specified by:

getResourceBundleKey in interface SearchExceptionCode

Returns:

the key into the resource bundle to get the error message

Skip navigation links