Package org.ametys.web.repository.page

Interface SitemapElement

All Superinterfaces:

AmetysObject, SiteAwareAmetysObject, TraversableAmetysObject

All Known Subinterfaces:

MetadataAwareSitemapElement, ModifiablePage, ModifiableSitemapElement, Page

All Known Implementing Classes:

AbstractConfigurableVirtualPage, AbstractOdfPage, AbstractProgramItemPage, AbstractSitemapElement, CoursePage, DefaultPage, FirstLevelPage, OrgUnitPage, ProgramPage, RedirectPage, SecondLevelPage, Sitemap, TransitionalPage, UGCPage, UGCTransitionalPage, UserPage

public interface SitemapElement
extends TraversableAmetysObject, SiteAwareAmetysObject

TraversableAmetysObject containing pages and which knows about its current site and sitemap, template, zones...

Field Summary

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

METADATA_SITE

Method Summary

Modifier and Type	Method	Description
Page	getChildPageAt(int index)	Gets the child Page at the given position
AmetysObjectIterable<? extends Page>	getChildrenPages()	Retrieves child pages.
AmetysObjectIterable<? extends Page>	getChildrenPages(boolean includeInvisiblePages)	Retrieves child pages.
String	getPathInSitemap()	Computes the path relative to the current sitemap.
Sitemap	getSitemap()	Retrieves the sitemap containing the current sitemap.
String	getSitemapName()	Returns this page's sitemap name
String	getTemplate()	Retrieves the template name.
ModelAwareDataHolder	getTemplateParametersHolder()	Get the view parameters
String	getTitle()	Retrieves the title.
Zone	getZone(String name)	Retrieves a given zone.
AmetysObjectIterable<? extends Zone>	getZones()	Retrieves the zones.
boolean	hasZone(String name)	Determine if a zone exists

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

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

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

getSite, getSiteName

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

getChild, getChildAt, getChildPosition, getChildren, hasChild

Method Details

getTitle

String getTitle()
         throws AmetysRepositoryException

Retrieves the title.

Returns:

the title.

Throws:

AmetysRepositoryException - if an error occurs.

getSitemap

Sitemap getSitemap()
            throws AmetysRepositoryException

Retrieves the sitemap containing the current sitemap.

Returns:

the sitemap containing the current sitemap.

Throws:

AmetysRepositoryException - if an error occurs.

getSitemapName

String getSitemapName()
               throws AmetysRepositoryException

Returns this page's sitemap name

Returns:

this page's sitemap name

Throws:

AmetysRepositoryException - if an error occurs.

getPathInSitemap

String getPathInSitemap()
                 throws AmetysRepositoryException

Computes the path relative to the current sitemap.

Returns:

the path relative to the current sitemap.

Throws:

AmetysRepositoryException - if an error occurs.

getChildrenPages

AmetysObjectIterable<? extends Page> getChildrenPages()
                                               throws AmetysRepositoryException

Retrieves child pages.

Returns:

the child pages.

Throws:

AmetysRepositoryException - if an error occurs.

getChildrenPages

AmetysObjectIterable<? extends Page> getChildrenPages(boolean includeInvisiblePages)
                                               throws AmetysRepositoryException

Retrieves child pages.

Parameters:

includeInvisiblePages - true to include invisible pages

Returns:

the child pages.

Throws:

AmetysRepositoryException - if an error occurs.

getChildPageAt

Page getChildPageAt(int index)
             throws UnknownAmetysObjectException,
AmetysRepositoryException

Gets the child Page at the given position

Parameters:

index - the position of the Page within the ordered set of its sibling objects.

Returns:

the Page if found

Throws:

AmetysRepositoryException - if an error occurs

UnknownAmetysObjectException - if no child page was found at this position

getTemplate

String getTemplate()
            throws AmetysRepositoryException

Retrieves the template name.

Returns:

the template name or null if none has been set or if the type is not container.

Throws:

AmetysRepositoryException - if an error occurs.

getTemplateParametersHolder

ModelAwareDataHolder getTemplateParametersHolder()
                                          throws AmetysRepositoryException

Get the view parameters

Returns:

the view parameters. Can be null.

Throws:

AmetysRepositoryException - if an error occurs.

getZones

AmetysObjectIterable<? extends Zone> getZones()
                                       throws AmetysRepositoryException

Retrieves the zones.

Returns:

the zones.

Throws:

AmetysRepositoryException - if an error occurs.

hasZone

boolean hasZone(String name)
         throws AmetysRepositoryException

Determine if a zone exists

Parameters:

name - The name of the zone

Returns:

true if the zone exists

Throws:

AmetysRepositoryException - If an error occured

getZone

Zone getZone(String name)
      throws UnknownZoneException,
AmetysRepositoryException

Retrieves a given zone.

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.