SitemapService (Ametys 4.3.x - API)

java.lang.Object
- org.ametys.runtime.plugin.component.AbstractLogEnabled
- - org.ametys.web.service.StaticService
  - - org.ametys.web.repository.sitemap.SitemapService

All Implemented Interfaces:

Model, ModelItemContainer, LogEnabled, PluginAware, Labelable, Service, Disposable, Configurable, Contextualizable, Serviceable
```
public class SitemapService
extends StaticService
```
Static service which cacheability depends on the restricted page policy of the current site.

Field Summary
- Fields inherited from class org.ametys.web.service.StaticService
  _context, _featureName, _manager, _modelItems, _paramsScript, _pluginName, _repeaterDefinitionParser, _serviceParameterDefinitionParser, _view, _viewAndParametersParser

Constructor Summary

Constructors
Constructor Description

SitemapService()

Method Summary

All Methods Instance Methods Concrete Methods
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.

Methods inherited from class org.ametys.web.service.StaticService
_configureClass, _configureImports, _configureScript, _parseI18nizableText, 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, service, 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

- Constructor Detail
  - SitemapService
```
public SitemapService()
```
- Method Detail
  - 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.