Package org.ametys.web.repository.page

Interface ModifiableSitemapElement

All Superinterfaces:

AmetysObject, ModifiableAmetysObject, SiteAwareAmetysObject, SitemapElement, TraversableAmetysObject

All Known Subinterfaces:

ModifiablePage

All Known Implementing Classes:

AbstractSitemapElement, DefaultPage, Sitemap

public interface ModifiableSitemapElement
extends SitemapElement, ModifiableAmetysObject

Sitemap element that can be modified

Field Summary

Fields inherited from interface org.ametys.web.repository.SiteAwareAmetysObject

METADATA_SITE

Method Summary

Modifier and Type	Method	Description
ModifiableZone	createZone(String name)	Creates a given zone.
ModifiableModelAwareDataHolder	getTemplateParametersHolder()	Get the view parameters
ModifiableZone	getZone(String name)	Retrieves a given zone.
AmetysObjectIterable<ModifiableZone>	getZones()	Retrieves the zones.

Methods inherited from interface org.ametys.plugins.repository.AmetysObject

equals, getId, getName, getParent, getParentPath, getPath, hashCode

Methods inherited from interface org.ametys.plugins.repository.ModifiableAmetysObject

needsSave, rename, revertChanges, saveChanges

Methods inherited from interface org.ametys.web.repository.SiteAwareAmetysObject

getSite, getSiteName

Methods inherited from interface org.ametys.web.repository.page.SitemapElement

getChildPageAt, getChildrenPages, getChildrenPages, getPathInSitemap, getSitemap, getSitemapName, getTemplate, getTitle, hasZone

Methods inherited from interface org.ametys.plugins.repository.TraversableAmetysObject

getChild, getChildAt, getChildPosition, getChildren, hasChild

Method Details

getZones

AmetysObjectIterable<ModifiableZone> getZones()
                                       throws AmetysRepositoryException

Retrieves the zones.

Specified by:

getZones in interface SitemapElement

Returns:

the zones.

Throws:

AmetysRepositoryException - if an error occurs.

getZone

ModifiableZone getZone(String name)
                throws UnknownZoneException,
AmetysRepositoryException

Retrieves a given zone.

Specified by:

getZone in interface SitemapElement

Parameters:

name - the name of the zone.

Returns:

the given zone.

Throws:

UnknownZoneException - if there is no zone for the given name.

AmetysRepositoryException - if an error occurs.

createZone

ModifiableZone createZone(String name)
                   throws AmetysRepositoryException

Creates a given zone.

Parameters:

name - the name of the zone.

Returns:

the given zone.

Throws:

AmetysRepositoryException - if an error occurs.

getTemplateParametersHolder

ModifiableModelAwareDataHolder getTemplateParametersHolder()
                                                    throws AmetysRepositoryException

Get the view parameters

Specified by:

getTemplateParametersHolder in interface SitemapElement

Returns:

the view parameters

Throws:

AmetysRepositoryException - if an error occurs.