Package org.ametys.web.frontoffice.search.requesttime.impl

Class SortSearchComponent

java.lang.Object

org.ametys.web.frontoffice.search.requesttime.impl.SortSearchComponent

All Implemented Interfaces:

SearchComponent

public class SortSearchComponent
extends Object
implements SearchComponent

SearchComponent for specifying the sort in the search.

Field Summary

Fields inherited from interface org.ametys.web.frontoffice.search.requesttime.SearchComponent

DISABLE_DEFAULT_SAX_PARAMETER_NAME, MAX_PRIORITY, MIN_PRIORITY, SEARCH_PRIORITY

Constructor Summary

Constructors

Constructor	Description
SortSearchComponent()

Method Summary

Modifier and Type	Method	Description
protected void	checkValidInputs(Map<String,SortDefinition> serviceProposedSortsById, List<Pair<String,Sort.Order>> userSorts)	Checks the user inputs are valid
void	execute(SearchComponentArguments args)	Executes the component.
int	priority()	Get the priority of the component.
protected void	setSearchLanguageAttribute(SearchComponentArguments args)	Sets the SEARCH_LOCALE attribute in request
boolean	supports(SearchComponentArguments args)	Returns true if the component must be executed.

Methods inherited from class java.lang.Object

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

Constructor Details

SortSearchComponent

public SortSearchComponent()

Method Details

priority

public int priority()

Description copied from interface: SearchComponent

Get the priority of the component. The lowest one will be executed first, and so on.

Specified by:

priority in interface SearchComponent

Returns:

the priority of the component

supports

public boolean supports(SearchComponentArguments args)

Description copied from interface: SearchComponent

Returns true if the component must be executed.

Specified by:

supports in interface SearchComponent

Parameters:

args - the arguments

Returns:

true if the component must be executed.

execute

public void execute(SearchComponentArguments args)
             throws Exception

Description copied from interface: SearchComponent

Executes the component.

Specified by:

execute in interface SearchComponent

Parameters:

args - the arguments

Throws:

Exception - if an exception occurs. Other search components will be attempted to be executed

checkValidInputs

protected void checkValidInputs(Map<String,SortDefinition> serviceProposedSortsById,
 List<Pair<String,Sort.Order>> userSorts)
                         throws org.ametys.web.frontoffice.search.requesttime.impl.InvalidUserInputException

Checks the user inputs are valid

Parameters:

serviceProposedSortsById - The proposed sorts of the service instance

userSorts - The user input sorts

Throws:

org.ametys.web.frontoffice.search.requesttime.impl.InvalidUserInputException - if at least user one input is invalid

setSearchLanguageAttribute

protected void setSearchLanguageAttribute(SearchComponentArguments args)

Sets the SEARCH_LOCALE attribute in request

Parameters:

args - the arguments