org.ametys.web.service

Interface Service

All Known Implementing Classes:

ExplorerFolderService, FilteredContentsService, FilteredPagesService, LinkDirectoryService, SearchService, SitemapService, StaticService, SyndicationService

public interface Service

Interface representing a business service.
A service is identified by a name and a Cocoon-URL.
This URL correspond to a pipeline called by a page template.
URL must be relative to the sitemap of the service.

Method Summary

Modifier and Type	Method and Description
I18nizableText	getCategory() Retrieves the category of the service.
List<ClientSideElement.ScriptFile>	getCSSFiles() Returns the list of CSS files needed to correctly display the service's in BO, such as the service's icon
I18nizableText	getDescription() Retrieves the description of the service.
String	getIconDecorator() Retrieves the CSS class to use for decorator above the main icon
String	getIconGlyph() Retrieves the CSS class to use for glyph icon
String	getId() Returns the service's id.
I18nizableText	getLabel() Retrieves the label of the service.
String	getLargeIcon() Retrieves the URL of the icon without the context path.
String	getMediumIcon() Retrieves the URL of the icon without the context path.
List<ServiceParameterGroup>	getParameterGroups() Returns the service parameter groups.
Map<String,ServiceParameterOrRepeater>	getParameters() Returns the service's parameters.
ClientSideElement.Script	getParametersScript() This method return the script that will be used to display parameters field.
String	getPluginName() Returns the plugin's name.
String	getRight() Get the right needed to create an instance of this service.
String	getSmallIcon() Retrieves the URL of the icon without the context path.
String	getURL() Returns the service's Cocoon-URL.
void	index(ZoneItem zoneItem, SolrInputDocument document) Fill the index with service data. This method is called during the containing page indexation process.
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.
boolean	isPrivate() Get whether the service is private, i.e.

Method Detail

getId

String getId()

Returns the service's id.

Returns:

the service's id.

getPluginName

String getPluginName()

Returns the plugin's name.

Returns:

the plugin's name.

getLabel

I18nizableText getLabel()

Retrieves the label of the service.

Returns:

the label.

getDescription

I18nizableText getDescription()

Retrieves the description of the service.

Returns:

the description.

getCategory

I18nizableText getCategory()

Retrieves the category of the service.

Returns:

the category.

getIconGlyph

String getIconGlyph()

Retrieves the CSS class to use for glyph icon

Returns:

the glyph name.

getIconDecorator

String getIconDecorator()

Retrieves the CSS class to use for decorator above the main icon

Returns:

the glyph name.

getSmallIcon

String getSmallIcon()

Retrieves the URL of the icon without the context path.

Returns:

the icon URL for the small image 16x16.

getMediumIcon

String getMediumIcon()

Retrieves the URL of the icon without the context path.

Returns:

the icon URL for the medium image 32x32.

getLargeIcon

String getLargeIcon()

Retrieves the URL of the icon without the context path.

Returns:

the icon URL for the large image 48x48.

getCSSFiles

List<ClientSideElement.ScriptFile> getCSSFiles()

Returns the list of CSS files needed to correctly display the service's in BO, such as the service's icon

Returns:

The list of CSS files needed. Must not be null.

getURL

String getURL()

Returns the service's Cocoon-URL.

Returns:

the service's Cocoon-URL.

getParameters

Map<String,ServiceParameterOrRepeater> getParameters()

Returns the service's parameters.

Returns:

the service's parameters.

getParameterGroups

List<ServiceParameterGroup> getParameterGroups()

Returns the service parameter groups.

Returns:

the service parameter groups.

getParametersScript

ClientSideElement.Script getParametersScript()

This method return the script that will be used to display parameters field.

Returns:

The script. Can be null.

isPrivate

boolean isPrivate()

Get whether the service is private, i.e. should not be created by the regular service interface.

Returns:

true if the service is private, false if it is public.

getRight

String getRight()

Get the right needed to create an instance of this service.

Returns:

the right needed to create an instance of this service. If null is returned, no right is needed.

isCacheable

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.

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.

index

void index(ZoneItem zoneItem,
           SolrInputDocument document)

Fill the index with service data.
This method is called during the containing page indexation process.

Parameters:

zoneItem - the ZoneItem containing an instance of this service.

document - the solr document for the containing Page.