org.ametys.web.frontoffice

Class SearchService

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

org.ametys.web.service.StaticService

org.ametys.web.frontoffice.SearchService

All Implemented Interfaces:

LogEnabled, PluginAware, Service, Disposable, Configurable, Contextualizable, Serviceable

public class SearchService
extends StaticService

Service which can be cacheable or not, depending on a parameter.

Nested Class Summary

Nested classes/interfaces inherited from class org.ametys.web.service.StaticService

StaticService.ServiceParameterOrRepeaterParser

Field Summary

Fields

Modifier and Type	Field and Description
protected AdditionalParameterFOSearchExtensionPoint	_additionalParameterFOSearch The additional parameter for FO search extension point

Fields inherited from class org.ametys.web.service.StaticService

_context, _featureName, _groups, _manager, _parameters, _paramsScript, _pluginName

Constructor Summary

Constructors

Constructor and Description
SearchService()

Method Summary

Modifier and Type	Method and Description
private ServiceParameterGroup	_getGroup(String paramName)
protected void	configureParameters(Configuration configuration, StaticService.ServiceParameterOrRepeaterParser serviceParameterParser) Configure the service parameters.
boolean	isCacheable(Page currentPage, ZoneItem zoneItem) Returns true if the result of this service may be cached, depending on the ZoneItem containing an instance of this service.
void	service(ServiceManager smanager)

Methods inherited from class org.ametys.web.service.StaticService

_configureClass, _configureImports, _configureScript, _parseI18nizableText, configure, configureIndexation, configureParameterGroup, configureParameterGroup, contextualize, dispose, getCategory, getCSSFiles, getDescription, getIconDecorator, getIconGlyph, getId, getLabel, getLargeIcon, getMediumIcon, getParameterGroups, getParameters, getParametersScript, getPluginName, getRight, getSmallIcon, getURL, index, isPrivate, setPluginInfo

Methods inherited from class org.ametys.runtime.plugin.component.AbstractLogEnabled

getLogger, setLogger

Methods inherited from class java.lang.Object

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

Field Detail

_additionalParameterFOSearch

protected AdditionalParameterFOSearchExtensionPoint _additionalParameterFOSearch

The additional parameter for FO search extension point

Constructor Detail

SearchService

public SearchService()

Method Detail

service

public void service(ServiceManager smanager)
             throws ServiceException

Specified by:

service in interface Serviceable

Overrides:

service in class StaticService

Throws:

ServiceException

isCacheable

public boolean isCacheable(Page currentPage,
                           ZoneItem zoneItem)

Description copied from interface: Service

Returns true if the result of this service may be cached, depending on the ZoneItem containing an instance of this service.

Specified by:

isCacheable in interface Service

Overrides:

isCacheable in class StaticService

Parameters:

currentPage - the current Page containing the service.

zoneItem - the ZoneItem containing an instance of this service.
N.B: The ZoneItem can belong to a page that is not the current page, when it is inherited.

Returns:

true if the result of this service may be cached.

configureParameters

protected void configureParameters(Configuration configuration,
                                   StaticService.ServiceParameterOrRepeaterParser serviceParameterParser)
                            throws ConfigurationException

Description copied from class: StaticService

Configure the service parameters.

Overrides:

configureParameters in class StaticService

Parameters:

configuration - the service configuration.

serviceParameterParser - the parser.

Throws:

ConfigurationException - if an error occurs.

_getGroup

private ServiceParameterGroup _getGroup(String paramName)