Package io.jmix.search.searching

Class SearchRequestContext<T>

java.lang.Object

io.jmix.search.searching.SearchRequestContext<T>

Type Parameters:

T - a platform-specific request builder type

public class SearchRequestContext<T>
extends Object

A container of the search request building information.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	SearchRequestContext.ProcessingState	A result of the SearchContext processing that is set during the search request building.

Field Summary

Fields

Modifier and Type	Field	Description
protected List<IndexSearchRequestScope>	indexSearchRequestScopes
protected final T	requestBuilder
protected SearchRequestContext.ProcessingState	requestPreparingState
protected SearchContext	searchContext

Constructor Summary

Constructors

Constructor	Description
SearchRequestContext(T requestBuilder, SearchContext searchContext)

Method Summary

Modifier and Type	Method	Description
Set<String>	getEffectiveIndexes()
List<IndexSearchRequestScope>	getIndexSearchRequestScopes()
SearchRequestContext.ProcessingState	getProcessingResult()
T	getRequestBuilder()
SearchContext	getSearchContext()
boolean	isRequestPossible()
void	setEmptyResult()
void	setPositiveResult(List<IndexSearchRequestScope> indexSearchRequestScopes)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

requestBuilder

protected final T requestBuilder

requestPreparingState

protected SearchRequestContext.ProcessingState requestPreparingState

searchContext

protected SearchContext searchContext

indexSearchRequestScopes

protected List<IndexSearchRequestScope> indexSearchRequestScopes

Constructor Details

SearchRequestContext

public SearchRequestContext(T requestBuilder,
 SearchContext searchContext)

Method Details

getRequestBuilder

public T getRequestBuilder()

setEmptyResult

public void setEmptyResult()

getProcessingResult

public SearchRequestContext.ProcessingState getProcessingResult()

getSearchContext

public SearchContext getSearchContext()

isRequestPossible

public boolean isRequestPossible()

setPositiveResult

public void setPositiveResult(List<IndexSearchRequestScope> indexSearchRequestScopes)

getIndexSearchRequestScopes

public List<IndexSearchRequestScope> getIndexSearchRequestScopes()

getEffectiveIndexes

public Set<String> getEffectiveIndexes()