Package org.ametys.web.frontoffice

Class SearchPagesService

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

org.ametys.web.service.StaticService

org.ametys.web.frontoffice.SearchPagesService

All Implemented Interfaces:

Model, ModelItemContainer, LogEnabled, PluginAware, Labelable, Service, Disposable, Configurable, Contextualizable, Serviceable

public class SearchPagesService
extends StaticService

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

Field Summary

Fields

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

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

_context, _featureName, _manager, _modelItems, _paramsScript, _pluginName, _repeaterDefinitionParser, _serviceParameterDefinitionParser, _view, _viewAndParametersParser

Constructor Summary

Constructors

Constructor	Description
SearchPagesService()

Method Summary

Modifier and Type	Method	Description
private void	_insertItemAfter(ModelViewItem itemToInsert, String insertAfter)
private boolean	_insertItemAfter(ModelViewItem itemToInsert, String paramName, ViewItemContainer currentContainer)
protected void	configureParameters(Configuration parametersConfiguration)	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, configureDialogBoxDimension, configureIndexation, contextualize, dispose, getCategory, getCreationBoxHeight, getCreationBoxWidth, getCSSFiles, getDescription, getIconDecorator, getIconGlyph, getId, getLabel, getLargeIcon, getMediumIcon, getModelItems, getName, getParameters, getParametersScript, getPluginName, getRight, getSmallIcon, getURL, getView, 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

Methods inherited from interface org.ametys.runtime.model.ModelItemContainer

getChild, getModelItem, hasModelItem

Methods inherited from interface org.ametys.web.service.Service

getFamilyId

Field Detail

_additionalParameterFOSearch

protected AdditionalParameterFOSearchExtensionPoint _additionalParameterFOSearch

The additional parameter for FO search extension point

Constructor Detail

SearchPagesService

public SearchPagesService()

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 parametersConfiguration)
                            throws ConfigurationException

Description copied from class: StaticService

Configure the service parameters

Overrides:

configureParameters in class StaticService

Parameters:

parametersConfiguration - the parameters configuration

Throws:

ConfigurationException - if a configuration exception occurred

_insertItemAfter

private void _insertItemAfter(ModelViewItem itemToInsert,
                              String insertAfter)

_insertItemAfter

private boolean _insertItemAfter(ModelViewItem itemToInsert,
                                 String paramName,
                                 ViewItemContainer currentContainer)