java.lang.Object
- com.attivio.sdk.error.ErrorCode
- - com.attivio.sdk.error.SearchEngineError

All Implemented Interfaces:

java.io.Serializable
```
public final class SearchEngineError
extends ErrorCode
```
Contains the error codes related to the search engine.

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field	Description
`static ErrorCode`	`ACCESS_CONTROL_ERROR`	SEARCH_ENGINE-29 Error occurred when evaluating access control query.
`static ErrorCode`	`ATTIVIO_SEARCHER_REQUIRED`	SEARCH_ENGINE-37 Internal method requires an AttivioSearcher instance.
`static ErrorCode`	`AUTO_WARM_ERROR`	SEARCH_ENGINE-26 Autowarm query failed.
`static ErrorCode`	`BOOST_QUERY_ERROR`	SEARCH_ENGINE-33 Failed to evaluate boost query.
`static ErrorCode`	`DOCID_CACHE_ERROR`	SEARCH_ENGINE-8 Failed to cache document ids
`static ErrorCode`	`DYNAMIC_FACET_ERROR`	SEARCH_ENGINE-7 Failed to generate dynamic facet
`static ErrorCode`	`ENGINE_ERROR`	SEARCH_ENGINE-2 An exception was encountered while trying to search the index.
`static ErrorCode`	`ENGINE_INITIALIZING`	SEARCH_ENGINE-45 The search engine is currently initializing and cannot serve queries.
`static ErrorCode`	`ENGINE_OFFLINE`	SEARCH_ENGINE-41 The search engine is currently offline and cannot serve queries.
`static ErrorCode`	`EQUIJOIN_ERROR`	SEARCH_ENGINE-39 Error occurred while executing an EQUI join.
`static ErrorCode`	`EVENT_HANDLER_ERROR`	SEARCH_ENGINE-11 An error occurred initializing an event handler.
`static ErrorCode`	`FACET_CACHE_ERROR`	SEARCH_ENGINE-6 Failed to cache terms for facet.
`static ErrorCode`	`FACET_ERROR`	SEARCH_ENGINE-3 An exception was encountered while generating facets for a query
`static ErrorCode`	`FACET_WARNING`	SEARCH_ENGINE-48 An facet warning was encountered.
`static ErrorCode`	`FIELD_CACHE_ERROR`	SEARCH_ENGINE-19 Failed to load cache for field
`static ErrorCode`	`FIELD_EXPRESSION_ERROR`	SEARCH_ENGINE-35 An error occurred while evaluating a FieldExpression.
`static ErrorCode`	`FIELD_NOT_INDEXED`	SEARCH_ENGINE-18 The use of an indexed field that does not exist was requested.
`static ErrorCode`	`FIELD_UNSUPPORTED`	SEARCH_ENGINE-46 The desired operation is not supported on the requested field.
`static ErrorCode`	`FILTER_ERROR`	SEARCH_ENGINE-23 Failed to apply filter to query.
`static ErrorCode`	`FRESHNESS_CACHE_ERROR`	SEARCH_ENGINE-31 Failed to load freshness cache.
`static ErrorCode`	`GENERATION_INITIALIZATION_FAILED`	SEARCH_ENGINE-15 Initialization of Search Generations Failed
`static ErrorCode`	`HIGHLIGHTING_ERROR`	SEARCH_ENGINE-14 Dynamic highlighting failed for a field
`static ErrorCode`	`ILLEGAL_JOIN`	SEARCH_ENGINE-17 Join query specified is illegal.
`static ErrorCode`	`INVALID_GENERATION_ERROR`	SEARCH_ENGINE-5 A generation that is no longer valid was requested.
`static ErrorCode`	`INVALID_JOIN_KEY`	SEARCH_ENGINE-27 Invalid/Unspecified join key field used
`static ErrorCode`	`NO_ACTIVE_GENERATION`	SEARCH_ENGINE-13 There is no active generation available
`static ErrorCode`	`PRE_SEARCH_EVENT_FAILED`	SEARCH_ENGINE-12 Running the preSearch event handler failed.
`static ErrorCode`	`PROTOCOL_ERROR`	SEARCH_ENGINE-43 Error transmitting/receiving data between nodes
`static ErrorCode`	`QUERY_EXPIRED`	SEARCH_ENGINE-38 Query has expired and cannot be recached.
`static ErrorCode`	`QUERY_LIMIT_EXCEEDED`	SEARCH_ENGINE-42 A query limit, such as too many clauses to a boolean query, has been exceeded.
`static ErrorCode`	`QUERY_REWRITE_FAILED`	SEARCH_ENGINE-32 Failed to rewrite query to optimized internal query.
`static ErrorCode`	`RENEW_LEASE_ERROR`	SEARCH_ENGINE-49 Search engine failed to renew lease for commit point.
`static ErrorCode`	`RETRIEVE_ERROR`	SEARCH_ENGINE-4 An exception was encountered while retrieving a stored document
`static ErrorCode`	`SCOPE_SEARCH_ERROR`	SEARCH_ENGINE-25 Scope search not supported.
`static ErrorCode`	`SEARCH_CACHE_ERROR`	SEARCH_ENGINE-20 Failed to cache documents matching a search.
`static ErrorCode`	`SEARCH_ERROR`	SEARCH_ENGINE-16 An exception was encountered while searching for documents matching a query
`static ErrorCode`	`SEARCH_TIMEOUT`	SEARCH_ENGINE-44 Timeout occurred while evaluating search
`static ErrorCode`	`SEARCHER_CLOSE_ERROR`	SEARCH_ENGINE-36 An error occurred while closing a searcher generation.
`static ErrorCode`	`SHUTDOWN_ERROR`	SEARCH_ENGINE-1 An exception was encountered while shutting down search engine.
`static ErrorCode`	`SORT_CACHE_ERROR`	SEARCH_ENGINE-22 Failed to cache terms for sort field.
`static ErrorCode`	`TEMP_FILE_ERROR`	SEARCH_ENGINE-47 An error occurred while using a temporary file.
`static ErrorCode`	`UNKNOWN_SCORE_FUNCTION_ERROR`	SEARCH_ENGINE-9 A query specifies an unknown scoring function.
`static ErrorCode`	`UNSUPPORTED_EVENT_HANDLER`	SEARCH_ENGINE-10 An event handler is unsupported by the search engine.
`static ErrorCode`	`UNSUPPORTED_FIELD_BOOST`	SEARCH_ENGINE-30 Static field boost is not supported on field.
`static ErrorCode`	`UNSUPPORTED_FIELD_EXPRESSION`	SEARCH_ENGINE-21 Field expression not supported by search engine.
`static ErrorCode`	`UNSUPPORTED_FILTER`	SEARCH_ENGINE-34 The desired filter is not supported by the search engine.
`static ErrorCode`	`UNSUPPORTED_QUERY`	SEARCH_ENGINE-28 Query is not supported by the search engine.
`static ErrorCode`	`UNSUPPORTED_SORT`	SEARCH_ENGINE-24 The desired sort is not supported on the field it was applied to.
`static ErrorCode`	`VERSION_ERROR`	SEARCH_ENGINE-40 Error occurred initializing index version.

Method Summary
- Methods inherited from class com.attivio.sdk.error.ErrorCode
  equals, formatError, getCategory, getCode, getErrorCode, hashCode, readResolve, toString
- Methods inherited from class java.lang.Object
  clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - SHUTDOWN_ERROR
```
public static final ErrorCode SHUTDOWN_ERROR
```
    SEARCH_ENGINE-1 An exception was encountered while shutting down search engine.
  - ENGINE_ERROR
```
public static final ErrorCode ENGINE_ERROR
```
    SEARCH_ENGINE-2 An exception was encountered while trying to search the index.
  - FACET_ERROR
```
public static final ErrorCode FACET_ERROR
```
    SEARCH_ENGINE-3 An exception was encountered while generating facets for a query
  - RETRIEVE_ERROR
```
public static final ErrorCode RETRIEVE_ERROR
```
    SEARCH_ENGINE-4 An exception was encountered while retrieving a stored document
  - INVALID_GENERATION_ERROR
```
public static final ErrorCode INVALID_GENERATION_ERROR
```
    SEARCH_ENGINE-5 A generation that is no longer valid was requested.
  - FACET_CACHE_ERROR
```
public static final ErrorCode FACET_CACHE_ERROR
```
    SEARCH_ENGINE-6 Failed to cache terms for facet.
  - DYNAMIC_FACET_ERROR
```
public static final ErrorCode DYNAMIC_FACET_ERROR
```
    SEARCH_ENGINE-7 Failed to generate dynamic facet
  - DOCID_CACHE_ERROR
```
public static final ErrorCode DOCID_CACHE_ERROR
```
    SEARCH_ENGINE-8 Failed to cache document ids
  - UNKNOWN_SCORE_FUNCTION_ERROR
```
public static final ErrorCode UNKNOWN_SCORE_FUNCTION_ERROR
```
    SEARCH_ENGINE-9 A query specifies an unknown scoring function.
  - UNSUPPORTED_EVENT_HANDLER
```
public static final ErrorCode UNSUPPORTED_EVENT_HANDLER
```
    SEARCH_ENGINE-10 An event handler is unsupported by the search engine.
  - EVENT_HANDLER_ERROR
```
public static final ErrorCode EVENT_HANDLER_ERROR
```
    SEARCH_ENGINE-11 An error occurred initializing an event handler.
  - PRE_SEARCH_EVENT_FAILED
```
public static final ErrorCode PRE_SEARCH_EVENT_FAILED
```
    SEARCH_ENGINE-12 Running the preSearch event handler failed.
  - NO_ACTIVE_GENERATION
```
public static final ErrorCode NO_ACTIVE_GENERATION
```
    SEARCH_ENGINE-13 There is no active generation available
  - HIGHLIGHTING_ERROR
```
public static final ErrorCode HIGHLIGHTING_ERROR
```
    SEARCH_ENGINE-14 Dynamic highlighting failed for a field
  - GENERATION_INITIALIZATION_FAILED
```
public static final ErrorCode GENERATION_INITIALIZATION_FAILED
```
    SEARCH_ENGINE-15 Initialization of Search Generations Failed
  - SEARCH_ERROR
```
public static final ErrorCode SEARCH_ERROR
```
    SEARCH_ENGINE-16 An exception was encountered while searching for documents matching a query
  - ILLEGAL_JOIN
```
public static final ErrorCode ILLEGAL_JOIN
```
    SEARCH_ENGINE-17 Join query specified is illegal.
  - FIELD_NOT_INDEXED
```
public static final ErrorCode FIELD_NOT_INDEXED
```
    SEARCH_ENGINE-18 The use of an indexed field that does not exist was requested.
  - FIELD_CACHE_ERROR
```
public static final ErrorCode FIELD_CACHE_ERROR
```
    SEARCH_ENGINE-19 Failed to load cache for field
  - SEARCH_CACHE_ERROR
```
public static final ErrorCode SEARCH_CACHE_ERROR
```
    SEARCH_ENGINE-20 Failed to cache documents matching a search.
  - UNSUPPORTED_FIELD_EXPRESSION
```
public static final ErrorCode UNSUPPORTED_FIELD_EXPRESSION
```
    SEARCH_ENGINE-21 Field expression not supported by search engine.
  - SORT_CACHE_ERROR
```
public static final ErrorCode SORT_CACHE_ERROR
```
    SEARCH_ENGINE-22 Failed to cache terms for sort field.
  - FILTER_ERROR
```
public static final ErrorCode FILTER_ERROR
```
    SEARCH_ENGINE-23 Failed to apply filter to query.
  - UNSUPPORTED_SORT
```
public static final ErrorCode UNSUPPORTED_SORT
```
    SEARCH_ENGINE-24 The desired sort is not supported on the field it was applied to.
  - SCOPE_SEARCH_ERROR
```
public static final ErrorCode SCOPE_SEARCH_ERROR
```
    SEARCH_ENGINE-25 Scope search not supported.
  - AUTO_WARM_ERROR
```
public static final ErrorCode AUTO_WARM_ERROR
```
    SEARCH_ENGINE-26 Autowarm query failed.
  - INVALID_JOIN_KEY
```
public static final ErrorCode INVALID_JOIN_KEY
```
    SEARCH_ENGINE-27 Invalid/Unspecified join key field used
  - UNSUPPORTED_QUERY
```
public static final ErrorCode UNSUPPORTED_QUERY
```
    SEARCH_ENGINE-28 Query is not supported by the search engine.
  - ACCESS_CONTROL_ERROR
```
public static final ErrorCode ACCESS_CONTROL_ERROR
```
    SEARCH_ENGINE-29 Error occurred when evaluating access control query.
  - UNSUPPORTED_FIELD_BOOST
```
public static final ErrorCode UNSUPPORTED_FIELD_BOOST
```
    SEARCH_ENGINE-30 Static field boost is not supported on field.
  - FRESHNESS_CACHE_ERROR
```
public static final ErrorCode FRESHNESS_CACHE_ERROR
```
    SEARCH_ENGINE-31 Failed to load freshness cache.
  - QUERY_REWRITE_FAILED
```
public static final ErrorCode QUERY_REWRITE_FAILED
```
    SEARCH_ENGINE-32 Failed to rewrite query to optimized internal query.
  - BOOST_QUERY_ERROR
```
public static final ErrorCode BOOST_QUERY_ERROR
```
    SEARCH_ENGINE-33 Failed to evaluate boost query.
  - UNSUPPORTED_FILTER
```
public static final ErrorCode UNSUPPORTED_FILTER
```
    SEARCH_ENGINE-34 The desired filter is not supported by the search engine.
  - FIELD_EXPRESSION_ERROR
```
public static final ErrorCode FIELD_EXPRESSION_ERROR
```
    SEARCH_ENGINE-35 An error occurred while evaluating a FieldExpression.
  - SEARCHER_CLOSE_ERROR
```
public static final ErrorCode SEARCHER_CLOSE_ERROR
```
    SEARCH_ENGINE-36 An error occurred while closing a searcher generation.
    This indicates closing a search generation did not complete successfully. This can result in memory and file handles not being reclaimed properly and could cause out of memory errors or prevent reclaimation of old index files.
  - ATTIVIO_SEARCHER_REQUIRED
```
public static final ErrorCode ATTIVIO_SEARCHER_REQUIRED
```
    SEARCH_ENGINE-37 Internal method requires an AttivioSearcher instance.
  - QUERY_EXPIRED
```
public static final ErrorCode QUERY_EXPIRED
```
    SEARCH_ENGINE-38 Query has expired and cannot be recached.
  - EQUIJOIN_ERROR
```
public static final ErrorCode EQUIJOIN_ERROR
```
    SEARCH_ENGINE-39 Error occurred while executing an EQUI join.
  - VERSION_ERROR
```
public static final ErrorCode VERSION_ERROR
```
    SEARCH_ENGINE-40 Error occurred initializing index version.
  - ENGINE_OFFLINE
```
public static final ErrorCode ENGINE_OFFLINE
```
    SEARCH_ENGINE-41 The search engine is currently offline and cannot serve queries.
  - QUERY_LIMIT_EXCEEDED
```
public static final ErrorCode QUERY_LIMIT_EXCEEDED
```
    SEARCH_ENGINE-42 A query limit, such as too many clauses to a boolean query, has been exceeded.
  - PROTOCOL_ERROR
```
public static final ErrorCode PROTOCOL_ERROR
```
    SEARCH_ENGINE-43 Error transmitting/receiving data between nodes
  - SEARCH_TIMEOUT
```
public static final ErrorCode SEARCH_TIMEOUT
```
    SEARCH_ENGINE-44 Timeout occurred while evaluating search
  - ENGINE_INITIALIZING
```
public static final ErrorCode ENGINE_INITIALIZING
```
    SEARCH_ENGINE-45 The search engine is currently initializing and cannot serve queries.
  - FIELD_UNSUPPORTED
```
public static final ErrorCode FIELD_UNSUPPORTED
```
    SEARCH_ENGINE-46 The desired operation is not supported on the requested field.
  - TEMP_FILE_ERROR
```
public static final ErrorCode TEMP_FILE_ERROR
```
    SEARCH_ENGINE-47 An error occurred while using a temporary file.
  - FACET_WARNING
```
public static final ErrorCode FACET_WARNING
```
    SEARCH_ENGINE-48 An facet warning was encountered.
  - RENEW_LEASE_ERROR
```
public static final ErrorCode RENEW_LEASE_ERROR
```
    SEARCH_ENGINE-49 Search engine failed to renew lease for commit point.

Class SearchEngineError

Field Summary

Method Summary

Methods inherited from class com.attivio.sdk.error.ErrorCode

Methods inherited from class java.lang.Object

Field Detail

SHUTDOWN_ERROR

ENGINE_ERROR

FACET_ERROR

RETRIEVE_ERROR

INVALID_GENERATION_ERROR

FACET_CACHE_ERROR

DYNAMIC_FACET_ERROR

DOCID_CACHE_ERROR

UNKNOWN_SCORE_FUNCTION_ERROR

UNSUPPORTED_EVENT_HANDLER

EVENT_HANDLER_ERROR

PRE_SEARCH_EVENT_FAILED

NO_ACTIVE_GENERATION

HIGHLIGHTING_ERROR

GENERATION_INITIALIZATION_FAILED

SEARCH_ERROR

ILLEGAL_JOIN

FIELD_NOT_INDEXED

FIELD_CACHE_ERROR

SEARCH_CACHE_ERROR

UNSUPPORTED_FIELD_EXPRESSION

SORT_CACHE_ERROR

FILTER_ERROR

UNSUPPORTED_SORT

SCOPE_SEARCH_ERROR

AUTO_WARM_ERROR

INVALID_JOIN_KEY

UNSUPPORTED_QUERY

ACCESS_CONTROL_ERROR

UNSUPPORTED_FIELD_BOOST

FRESHNESS_CACHE_ERROR

QUERY_REWRITE_FAILED

BOOST_QUERY_ERROR

UNSUPPORTED_FILTER

FIELD_EXPRESSION_ERROR

SEARCHER_CLOSE_ERROR

ATTIVIO_SEARCHER_REQUIRED

QUERY_EXPIRED

EQUIJOIN_ERROR

VERSION_ERROR

ENGINE_OFFLINE

QUERY_LIMIT_EXCEEDED

PROTOCOL_ERROR

SEARCH_TIMEOUT

ENGINE_INITIALIZING

FIELD_UNSUPPORTED

TEMP_FILE_ERROR

FACET_WARNING

RENEW_LEASE_ERROR