SearchComponent (Ametys 4.2.x

All Known Implementing Classes:

CheckRightSearchComponent, CriterionTreeSearchComponent, DebugSearchComponent, FacetSearchComponent, MatchingSubprogramSearchComponent, PaginationSearchComponent, ReturnableSearchComponent, RssSearchComponent, SaveUserPrefsSearchComponent, SaxFormSearchComponent, SaxGeneralDataSearchComponent, SaxResultsSearchComponent, SetResultsSearchComponent, SortSearchComponent, WorkspaceSwitcherSearchComponent
```
public interface SearchComponent
```
A component which will execute a part of a FO search through SearchServiceGenerator.

Field Summary

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

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`void`	`execute(SearchComponentArguments args)` Executes the component.
`int`	`priority()` Get the priority of the component.
`boolean`	`supports(SearchComponentArguments args)` Returns `true` if the component must be `executed`.

- Field Detail
  - 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 priority() 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 Detail
  - priority
```
int priority()
```
    Get the priority of the component. The lowest one will be executed first, and so on.
    
    Returns:
    
    the priority of the component
  - supports
```
boolean supports(SearchComponentArguments args)
```
    Returns true if the component must be executed.
    
    Parameters:
    
    args - the arguments
    
    Returns:
    
    true if the component must be executed.
  - 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

Interface SearchComponent

Field Summary

Method Summary

Field Detail

MIN_PRIORITY

SEARCH_PRIORITY

MAX_PRIORITY

DISABLE_DEFAULT_SAX_PARAMETER_NAME

Method Detail

priority

supports

execute