org.ametys.web.frontoffice.search.requesttime

Class SearchComponentArguments

java.lang.Object

org.ametys.web.frontoffice.search.requesttime.SearchComponentArguments

public class SearchComponentArguments
extends Object

Wrapper of arguments passed to SearchComponent#execute

Field Summary

Fields

Modifier and Type	Field and Description
private ContentHandler	_contentHandler
private String	_currentLang
private Page	_currentPage
private Site	_currentSite
private SearchServiceDebugModeHelper.DebugMode	_debugMode
private Parameters	_generatorParameters
private boolean	_launchSearch
private Logger	_logger
private Request	_request
private Response	_response
private int	_resultPageIndex
private SearchResults<AmetysObject>	_results
private int	_resultsPerPage
private SearcherFactory.Searcher	_searcher
private SearchService	_service
private SearchServiceInstance	_serviceInstance
private int	_start
private SearchUserInputs	_userInputs

Constructor Summary

Constructors

Constructor and Description

SearchComponentArguments(ContentHandler contentHandler, Parameters generatorParameters, SearchServiceInstance serviceInstance, SearchService service, SearchUserInputs userInputs, Request request, Response response, int resultPageIndex, int start, int resultsPerPage, Site currentSite, Page currentPage, String currentLang, boolean launchSearch, SearcherFactory.Searcher searcher, Logger logger, SearchServiceDebugModeHelper.DebugMode debugMode)

Method Summary

Modifier and Type	Method and Description
ContentHandler	contentHandler() Gets the content handler
String	currentLang() Gets the current lang
Page	currentPage() Gets the current page
Site	currentSite() Gets the current site
Optional<SearchServiceDebugModeHelper.DebugMode>	debugMode() Gets the debug mode
Parameters	generatorParameters() Gets the parameters of the generator, allowing to change some behaviors depending on the URL the request comes from
boolean	isDebug() Returns true if debug is activated
boolean	launchSearch() Returns true if the search has to be launch
Logger	logger() Gets the logger
Request	request() Gets the current request
Response	response() Gets the response
int	resultPageIndex() Gets the result page index
Optional<SearchResults<AmetysObject>>	results() Gets the results of the search.
int	resultsPerPage() Gets the number of results per page
SearcherFactory.Searcher	searcher() Gets the searcher
SearchService	service() Gets the search service
SearchServiceInstance	serviceInstance() Gets the search service instance
void	setResults(SearchResults<AmetysObject> results) Sets the results
int	start() Gets the start index (i.e.
SearchUserInputs	userInputs() Gets the user inputs

Methods inherited from class java.lang.Object

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

Field Detail

_contentHandler

private ContentHandler _contentHandler

_generatorParameters

private Parameters _generatorParameters

_serviceInstance

private SearchServiceInstance _serviceInstance

_service

private SearchService _service

_userInputs

private SearchUserInputs _userInputs

_request

private Request _request

_response

private Response _response

_resultPageIndex

private int _resultPageIndex

_start

private int _start

_resultsPerPage

private int _resultsPerPage

_currentSite

private Site _currentSite

_currentPage

private Page _currentPage

_currentLang

private String _currentLang

_launchSearch

private boolean _launchSearch

_results

private SearchResults<AmetysObject> _results

_searcher

private SearcherFactory.Searcher _searcher

_logger

private Logger _logger

_debugMode

private SearchServiceDebugModeHelper.DebugMode _debugMode

Constructor Detail

SearchComponentArguments

SearchComponentArguments(ContentHandler contentHandler,
                         Parameters generatorParameters,
                         SearchServiceInstance serviceInstance,
                         SearchService service,
                         SearchUserInputs userInputs,
                         Request request,
                         Response response,
                         int resultPageIndex,
                         int start,
                         int resultsPerPage,
                         Site currentSite,
                         Page currentPage,
                         String currentLang,
                         boolean launchSearch,
                         SearcherFactory.Searcher searcher,
                         Logger logger,
                         SearchServiceDebugModeHelper.DebugMode debugMode)

Method Detail

contentHandler

public ContentHandler contentHandler()

Gets the content handler

Returns:

the content handler

generatorParameters

public Parameters generatorParameters()

Gets the parameters of the generator, allowing to change some behaviors depending on the URL the request comes from

Returns:

the parameters of the generator

serviceInstance

public SearchServiceInstance serviceInstance()

Gets the search service instance

Returns:

the search service instance

service

public SearchService service()

Gets the search service

Returns:

the search service

userInputs

public SearchUserInputs userInputs()

Gets the user inputs

Returns:

the user inputs

request

public Request request()

Gets the current request

Returns:

the current request

response

public Response response()

Gets the response

Returns:

the response

resultPageIndex

public int resultPageIndex()

Gets the result page index

Returns:

the result page index

start

public int start()

Gets the start index (i.e. offset) of the search

Returns:

the start index

resultsPerPage

public int resultsPerPage()

Gets the number of results per page

Returns:

the number of results per page

currentSite

public Site currentSite()

Gets the current site

Returns:

the current site

currentPage

public Page currentPage()

Gets the current page

Returns:

the current page

currentLang

public String currentLang()

Gets the current lang

Returns:

the current lang

launchSearch

public boolean launchSearch()

Returns true if the search has to be launch

Returns:

true if the search has to be launch

setResults

public void setResults(SearchResults<AmetysObject> results)

Sets the results

Parameters:

results - the results

results

public Optional<SearchResults<AmetysObject>> results()

Gets the results of the search. Can be empty if search has not been executed yet

Returns:

the results of the search, or an empty optional if search has not been executed yet

searcher

public SearcherFactory.Searcher searcher()

Gets the searcher

Returns:

the searcher

logger

public Logger logger()

Gets the logger

Returns:

the logger

isDebug

public boolean isDebug()

Returns true if debug is activated

Returns:

true if debug is activated

debugMode

public Optional<SearchServiceDebugModeHelper.DebugMode> debugMode()

Gets the debug mode

Returns:

the debug mode