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

Class ReturnableSearchComponent

java.lang.Object

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

All Implemented Interfaces:

SearchComponent, Serviceable

public class ReturnableSearchComponent
extends Object
implements SearchComponent, Serviceable

SearchComponent for restricting the results to the Returnables

Field Summary

Fields

Modifier and Type	Field	Description
protected SearchComponentHelper	_searchComponentHelper	The helper for search component

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
ReturnableSearchComponent()

Method Summary

Modifier and Type	Method	Description
void	execute(SearchComponentArguments args)	Executes the component.
int	priority()	Get the priority of the component.
void	service(ServiceManager manager)
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

Field Details

_searchComponentHelper

protected SearchComponentHelper _searchComponentHelper

The helper for search component

Constructor Details

ReturnableSearchComponent

public ReturnableSearchComponent()

Method Details

service

public void service(ServiceManager manager)
             throws ServiceException

Specified by:

service in interface Serviceable

Throws:

ServiceException

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