org.ametys.web.frontoffice.search.requesttime.input

Class SearchUserInputsRetriever

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

org.ametys.web.frontoffice.search.requesttime.input.SearchUserInputsRetriever

All Implemented Interfaces:

LogEnabled, Component, Serviceable

public class SearchUserInputsRetriever
extends AbstractLogEnabled
implements Component, Serviceable

The SearchUserInputs retriever.

Field Summary

Fields

Modifier and Type	Field and Description
protected CurrentUserProvider	_currentUserProvider The current user provider
protected JSONUtils	_jsonUtils The JSON utils
protected UserPreferencesManager	_userPrefsManager The user preferences manager
static String	ROLE The avalon role

Constructor Summary

Constructors

Constructor and Description
SearchUserInputsRetriever()

Method Summary

Modifier and Type	Method and Description
protected SearchUserInputs	_getCurrentSearchUserInputs(String serviceId) Get the current search user inputs for the given service.
SearchUserInputs	getUserInputs(Request request, boolean isFormSubmitted, SearchServiceInstance serviceInstance) Get the user inputs.
void	service(ServiceManager manager)

Methods inherited from class org.ametys.runtime.plugin.component.AbstractLogEnabled

getLogger, setLogger

Methods inherited from class java.lang.Object

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

Field Detail

ROLE

public static final String ROLE

The avalon role

_currentUserProvider

protected CurrentUserProvider _currentUserProvider

The current user provider

_userPrefsManager

protected UserPreferencesManager _userPrefsManager

The user preferences manager

_jsonUtils

protected JSONUtils _jsonUtils

The JSON utils

Constructor Detail

SearchUserInputsRetriever

public SearchUserInputsRetriever()

Method Detail

service

public void service(ServiceManager manager)
             throws ServiceException

Specified by:

service in interface Serviceable

Throws:

ServiceException

getUserInputs

public SearchUserInputs getUserInputs(Request request,
                                      boolean isFormSubmitted,
                                      SearchServiceInstance serviceInstance)

Get the user inputs. Implementation depends on the search parameters.

Parameters:

request - The request

isFormSubmitted - true if the form has been submitted

serviceInstance - The search service instance

Returns:

The search user inputs (criteria, facets, sorts)

_getCurrentSearchUserInputs

protected SearchUserInputs _getCurrentSearchUserInputs(String serviceId)

Get the current search user inputs for the given service.

Parameters:

serviceId - The service ID

Returns:

A SearchUserInputs object if the user is authenticated and have saved filters for this service. Otherwise, it returns null.