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

Interface SearchComponent

All Superinterfaces:

PluginAware, Prioritizable, Supporter<SearchComponentArguments>

All Known Implementing Classes:

AbstractSearchComponent, AbstractSkillSearchComponent, CalendarSaxFormSearchComponent, CalendarSaxGeneralDataSearchComponent, CalendarSearchComponent, CheckRightSearchComponent, CriterionTreeSearchComponent, DateRangeCriterionSearchComponent, DebugSearchComponent, DegreeUniversitySearchComponent, FacetSearchComponent, MatchingSubprogramSearchComponent, PaginationSearchComponent, ReturnableSearchComponent, RssSearchComponent, SaveUserPrefsSearchComponent, SaveUserPrefsSearchComponent, SaxDegreeUniversityEnumeratedCriteriaComponent, SaxEnumeratedCriteriaComponent, SaxFormSearchComponent, SaxGeneralDataSearchComponent, SaxResultsSearchComponent, SaxSkillSearchComponent, SetResultsSearchComponent, SkillSearchComponent, SortSearchComponent, TagFacetSearchComponent, WorkspaceSwitcherSearchComponent

public interface SearchComponent
extends Prioritizable, Supporter<SearchComponentArguments>, PluginAware

A component which will execute a part of a FO search through SearchServiceGenerator.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DISABLE_DEFAULT_SAX_PARAMETER_NAME	A generator parameter name for disabling default sax and use a custom search component instead
static final int	MAX_PRIORITY	Maximum priority
static final int	MIN_PRIORITY	Minimum priority
static final int	SEARCH_PRIORITY	Priority of the component executing the search and setting the results.

Method Summary

Modifier and Type	Method	Description
void	execute(SearchComponentArguments args)	Executes the component.
String	getId()	Get the identifier of the search component

Methods inherited from interface org.ametys.runtime.plugin.component.PluginAware

setPluginInfo

Methods inherited from interface org.ametys.runtime.plugin.component.Prioritizable

getPriority

Methods inherited from interface org.ametys.runtime.plugin.component.Supporter

supports

Field Details

MIN_PRIORITY

static final int MIN_PRIORITY

Minimum priority

See Also:

• Constant Field Values

SEARCH_PRIORITY

static final int SEARCH_PRIORITY

Priority of the component executing the search and setting the results.
Thus, this constant can be used to define Prioritizable.getPriority() method whether the component must execute before or after the search.

See Also:

• Constant Field Values

MAX_PRIORITY

static final int MAX_PRIORITY

Maximum priority

See Also:

• Constant Field Values

DISABLE_DEFAULT_SAX_PARAMETER_NAME

static final String DISABLE_DEFAULT_SAX_PARAMETER_NAME

A generator parameter name for disabling default sax and use a custom search component instead

See Also:

• Constant Field Values

Method Details

execute

void execute(SearchComponentArguments args)
      throws Exception

Executes the component.

Parameters:

args - the arguments

Throws:

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

getId

String getId()

Get the identifier of the search component

Returns:

the identifier