org.ametys.web.repository.page

Interface PagesContainer

All Superinterfaces:

AmetysObject, SiteAwareAmetysObject, TraversableAmetysObject

All Known Subinterfaces:

MetadataAwarePagesContainer, ModifiablePage, Page

All Known Implementing Classes:

AbstractBlogPage, CoursePage, DefaultPage, FirstLevelPage, OrgUnitPage, ProgramPage, SecondLevelPage, Sitemap, TransitionalPage, UserPage, VirtualMonthPage, VirtualPostPage, VirtualPostsPage, VirtualTagPage, VirtualTagsPage, VirtualYearPage, VirtualYearsPage

public interface PagesContainer
extends TraversableAmetysObject, SiteAwareAmetysObject

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

Method Summary

Modifier and Type	Method and 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

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

getChild, getChildAt, getChildPosition, getChildren, hasChild

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

getSite, getSiteName

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

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

Method Detail

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