org.ametys.web.repository.page

Interface Page

All Superinterfaces:

AmetysObject, MetadataAwareAmetysObject, MetadataAwarePagesContainer, PagesContainer, SiteAwareAmetysObject, TagAwareAmetysObject, TraversableAmetysObject

All Known Subinterfaces:

ModifiablePage

All Known Implementing Classes:

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

public interface Page
extends MetadataAwarePagesContainer, TagAwareAmetysObject

AmetysObject for reading page informations.<p>

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	Page.LinkType Type of a link page.
static class	Page.PageType Type of a page.

Method Summary

Modifier and Type	Method and Description
int	getDepth() Get the page depth
String	getLongTitle() Retrieves the long title.
Set<String>	getReferers() Retrieves all AmetysObject ids referencing this page.
ResourceCollection	getRootAttachments() Retrieves the attachments root node
String	getTemplate() Retrieves the template name.
String	getTitle() Retrieves the title.
Page.PageType	getType() Retrieves the type.
String	getURL() Retrieves the linked URL.
Page.LinkType	getURLType() Retrieves the linked URL type.
Zone	getZone(String name) Retrieves a given zone.
AmetysObjectIterable<? extends Zone>	getZones() Retrieves the zones.
boolean	hasZone(String name) Determine if a zone exists
boolean	isVisible() Determine if the page is visible into navigation elements

Methods inherited from interface org.ametys.plugins.repository.metadata.MetadataAwareAmetysObject

getMetadataHolder

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

getChildPageAt, getChildrenPages, getChildrenPages, getPathInSitemap, getSitemap, getSitemapName

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

Methods inherited from interface org.ametys.cms.repository.TagAwareAmetysObject

getTags

Method Detail

getTitle

String getTitle()
         throws AmetysRepositoryException

Retrieves the title.

Returns:

the title.

Throws:

AmetysRepositoryException - if an error occurs.

getLongTitle

String getLongTitle()
             throws AmetysRepositoryException

Retrieves the long title.

Returns:

the title.

Throws:

AmetysRepositoryException - if an error occurs.

getType

Page.PageType getType()
               throws AmetysRepositoryException

Retrieves the type.

Returns:

the type.

Throws:

AmetysRepositoryException - if an error occurs.

See Also:

Page.PageType

getURL

String getURL()
       throws AmetysRepositoryException

Retrieves the linked URL.

Returns:

the linked URL.

Throws:

AmetysRepositoryException - if an error occurs.

getURLType

Page.LinkType getURLType()
                  throws AmetysRepositoryException

Retrieves the linked URL type.

Returns:

the linked URL type.

Throws:

AmetysRepositoryException - if an error occurs.

getDepth

int getDepth()
      throws AmetysRepositoryException

Get the page depth

Returns:

the page depth

Throws:

AmetysRepositoryException - if an error occurs.

getTemplate

String getTemplate()
            throws AmetysRepositoryException

Retrieves the template name.

Returns:

the template name or null if none has been set.

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.

getRootAttachments

ResourceCollection getRootAttachments()
                               throws AmetysRepositoryException

Retrieves the attachments root node

Returns:

The the attachments root node

Throws:

AmetysRepositoryException - if an error occurs.

getReferers

Set<String> getReferers()
                 throws AmetysRepositoryException

Retrieves all AmetysObject ids referencing this page.

Returns:

the AmetysObject ids referencing this page.

Throws:

AmetysRepositoryException - if an error occurs.

isVisible

boolean isVisible()
           throws AmetysRepositoryException

Determine if the page is visible into navigation elements

Returns:

true if the page is visible.

Throws:

AmetysRepositoryException - if an error occurs.