Interface SearchComponent
-
- All Known Implementing Classes:
AbstractSkillSearchComponent
,CheckRightSearchComponent
,CriterionTreeSearchComponent
,DebugSearchComponent
,FacetSearchComponent
,MatchingSubprogramSearchComponent
,PaginationSearchComponent
,ReturnableSearchComponent
,RssSearchComponent
,SaveUserPrefsSearchComponent
,SaxFormSearchComponent
,SaxGeneralDataSearchComponent
,SaxResultsSearchComponent
,SaxSkillSearchComponent
,SetResultsSearchComponent
,SkillSearchComponent
,SortSearchComponent
,WorkspaceSwitcherSearchComponent
public interface SearchComponent
A component which will execute a part of a FO search throughSearchServiceGenerator
.
-
-
Field Summary
Fields Modifier and Type Field Description static String
DISABLE_DEFAULT_SAX_PARAMETER_NAME
Agenerator parameter name
for disabling default sax and use a custom search component insteadstatic int
MAX_PRIORITY
Maximum prioritystatic int
MIN_PRIORITY
Minimum prioritystatic int
SEARCH_PRIORITY
Priority of the component executing thesearch
andsetting the results
.
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description void
execute(SearchComponentArguments args)
Executes the component.int
priority()
Get the priority of the component.boolean
supports(SearchComponentArguments args)
Returnstrue
if the component must beexecuted
.
-
-
-
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 thesearch
andsetting the results
.
Thus, this constant can be used to definepriority()
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
Agenerator 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)
Returnstrue
if the component must beexecuted
.- Parameters:
args
- the arguments- Returns:
true
if the component must beexecuted
.
-
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
-
-