Package io.jmix.search.searching

Enum Class SearchRequestContext.ProcessingState

java.lang.Object

java.lang.Enum<SearchRequestContext.ProcessingState>

io.jmix.search.searching.SearchRequestContext.ProcessingState

All Implemented Interfaces:

Serializable, Comparable<SearchRequestContext.ProcessingState>, Constable

Enclosing class:

SearchRequestContext<T>

public static enum SearchRequestContext.ProcessingState
extends Enum<SearchRequestContext.ProcessingState>

A result of the SearchContext processing that is set during the search request building.

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
NO_AVAILABLE_ENTITIES	This state is set to SearchRequestContext when a SearchContext processing is finished and a request sending is not possible due to there are no any entities and correspondent indexes for searching.
READY	This state is set to SearchRequestContext when a SearchContext processing is finished and a request sending is possible.
UNPROCESSED	This state is set to SearchRequestContext before its processing.

Method Summary

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

UNPROCESSED

public static final SearchRequestContext.ProcessingState UNPROCESSED

This state is set to SearchRequestContext before its processing.

READY

public static final SearchRequestContext.ProcessingState READY

This state is set to SearchRequestContext when a SearchContext processing is finished and a request sending is possible.

NO_AVAILABLE_ENTITIES

public static final SearchRequestContext.ProcessingState NO_AVAILABLE_ENTITIES

This state is set to SearchRequestContext when a SearchContext processing is finished and a request sending is not possible due to there are no any entities and correspondent indexes for searching. Such result is possible because of the user doesn't have necessary permissions for the requested entities.

Method Details

values

public static SearchRequestContext.ProcessingState[] 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 SearchRequestContext.ProcessingState 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