Package org.ametys.web.repository.page

Interface Page

All Superinterfaces:

AmetysObject, DataAwareAmetysObject, DataHolder, MetadataAwareSitemapElement, ModelLessDataAwareAmetysObject, ModelLessDataHolder, SiteAwareAmetysObject, SitemapElement, TagAwareAmetysObject, TraversableAmetysObject

All Known Subinterfaces:

ModifiablePage

All Known Implementing Classes:

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

public interface Page
extends MetadataAwareSitemapElement, TagAwareAmetysObject

AmetysObject for reading page informations.<p>

Nested Class Summary

Nested Classes

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

Field Summary

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

METADATA_SITE

Method Summary

Modifier and Type	Method	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
Page.PageType	getType()	Retrieves the type.
String	getURL()	Retrieves the linked URL.
Page.LinkType	getURLType()	Retrieves the linked URL type.
boolean	isVisible()	Determine if the page is visible into navigation elements

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

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

Methods inherited from interface org.ametys.plugins.repository.data.ametysobject.DataAwareAmetysObject

copyTo, copyTo, dataToJSON, dataToJSON, dataToSAX, dataToSAX, getDataNames, getRepositoryData

Methods inherited from interface org.ametys.plugins.repository.data.ametysobject.ModelLessDataAwareAmetysObject

dataToJSON, dataToSAX, getComposite, getDataHolder, getModelItemTypeExtensionPoint, getParentDataHolder, getRootDataHolder, getType, getValue, getValue, getValueOfType, getValueOfType, hasDifferences, hasValue, hasValue, hasValueOrEmpty, isMultiple, isMultiple

Methods inherited from interface org.ametys.plugins.repository.data.holder.ModelLessDataHolder

dataToJSON, dataToSAX

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, getTemplateParametersHolder, getTitle, getZone, getZones, hasZone

Methods inherited from interface org.ametys.plugins.repository.tag.TagAwareAmetysObject

getTags

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

getChild, getChildAt, getChildPosition, getChildren, hasChild

Method Details

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.

getRootAttachments

ResourceCollection getRootAttachments()
                               throws AmetysRepositoryException

Retrieves the attachments root node

Returns:

The the attachments root node. Can be null if the page does not supports attachments

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.