Package org.ametys.plugins.linkdirectory

Class LinkDirectoryService

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

org.ametys.web.service.StaticService

org.ametys.plugins.linkdirectory.LinkDirectoryService

All Implemented Interfaces:

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

public class LinkDirectoryService
extends StaticService

Service for the link directory : not cacheable when dealing with links that have a limited access or internal url

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CONFIGURABLE_LINKS_PARAMETER	Name of service's parameter holding the configurable option
static final String	DISPLAY_USER_LINKS_PARAMETER	Name of service's parameter holding the display user links option

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

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

Constructor Summary

Constructors

Constructor	Description
LinkDirectoryService()

Method Summary

Modifier and Type	Method	Description
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, configure, configureDialogBoxDimension, configureIndexation, configureParameters, 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.ModelItemAccessor

getChild, getModelItem, hasModelItem

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

getFamilyId

Field Details

DISPLAY_USER_LINKS_PARAMETER

public static final String DISPLAY_USER_LINKS_PARAMETER

Name of service's parameter holding the display user links option

See Also:

• Constant Field Values

CONFIGURABLE_LINKS_PARAMETER

public static final String CONFIGURABLE_LINKS_PARAMETER

Name of service's parameter holding the configurable option

See Also:

• Constant Field Values

Constructor Details

LinkDirectoryService

public LinkDirectoryService()

Method Details

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.