Package org.ametys.plugins.odfweb.repository

Class CoursePage

java.lang.Object

org.ametys.plugins.odfweb.repository.AbstractOdfPage

org.ametys.plugins.odfweb.repository.CoursePage

All Implemented Interfaces:

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

public class CoursePage
extends AbstractOdfPage

Page representing a course.

Nested Class Summary

Nested classes/interfaces inherited from interface org.ametys.web.repository.page.Page

Page.LinkType, Page.PageType

Field Summary

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

METADATA_SITE

Constructor Summary

Constructors

Constructor	Description
CoursePage(CoursePageFactory factory, Page root, Course course, Program parentProgram, String path, Page parentPage)	Constructor.

Method Summary

Modifier and Type	Method	Description
<A extends AmetysObject> A	getChild(String path)	Retrieves a given child from its relative path.
AmetysObjectIterable<? extends Page>	getChildrenPages()	Retrieves child pages.
Course	getCourse()	Returns the associated Course.
ModelLessDataHolder	getDataHolder()	Returns the DataHolder of this AmetysObject.
int	getDepth()	Get the page depth
String	getId()	Retrieves the unique identifier of this AmetysObject. It must be unique in the whole repository and must never be null. It must conform to the URI syntax: <protocol>://<protocol-specific-part>
String	getLongTitle()	Retrieves the long title.
String	getName()	Retrieves the name of the current object.
Page	getParent()	Returns the parent object in the Ametys hierarchy.
String	getParentPath()	Returns the path of the parent object in the Ametys hierarchy.
String	getPathInSitemap()	Computes the path relative to the current sitemap.
Site	getSite()	Returns this object's site.
Sitemap	getSitemap()	Retrieves the sitemap containing the current sitemap.
String	getSitemapName()	Returns this page's sitemap name
String	getSiteName()	Returns this object's site 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	hasChild(String name)	Tests if this Object has at least one child with the given name.

Methods inherited from class org.ametys.plugins.odfweb.repository.AbstractOdfPage

getChildPageAt, getChildren, getChildrenPages, getPath, getReferers, getRootAttachments, getTags, getType, getURL, getURLType, hasZone, isVisible

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

equals, hashCode

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

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

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

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

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

dataToJSON, dataToSAX

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

getChildAt, getChildPosition

Constructor Details

CoursePage

public CoursePage(CoursePageFactory factory,
 Page root,
 Course course,
 Program parentProgram,
 String path,
 Page parentPage)

Constructor.

Parameters:

factory - The factory

root - the odf root page.

course - the course.

parentProgram - the parent program

path - path from the parent ProgramPage

parentPage - the parent Page or null if not yet computed.

Method Details

getCourse

public Course getCourse()

Returns the associated Course.

Returns:

the associated Course.

getDepth

public int getDepth()
             throws AmetysRepositoryException

Description copied from interface: Page

Get the page depth

Returns:

the page depth

Throws:

AmetysRepositoryException - if an error occurs.

getTemplate

public String getTemplate()
                   throws AmetysRepositoryException

Description copied from interface: SitemapElement

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.

getTitle

public String getTitle()
                throws AmetysRepositoryException

Description copied from interface: SitemapElement

Retrieves the title.

Returns:

the title.

Throws:

AmetysRepositoryException - if an error occurs.

getLongTitle

public String getLongTitle()
                    throws AmetysRepositoryException

Description copied from interface: Page

Retrieves the long title.

Returns:

the title.

Throws:

AmetysRepositoryException - if an error occurs.

getZone

public Zone getZone(String name)
             throws UnknownZoneException,
AmetysRepositoryException

Description copied from interface: SitemapElement

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.

getZones

public AmetysObjectIterable<? extends Zone> getZones()
                                              throws AmetysRepositoryException

Description copied from interface: SitemapElement

Retrieves the zones.

Returns:

the zones.

Throws:

AmetysRepositoryException - if an error occurs.

getChildrenPages

public AmetysObjectIterable<? extends Page> getChildrenPages()
                                                      throws AmetysRepositoryException

Description copied from interface: SitemapElement

Retrieves child pages.

Returns:

the child pages.

Throws:

AmetysRepositoryException - if an error occurs.

getPathInSitemap

public String getPathInSitemap()
                        throws AmetysRepositoryException

Description copied from interface: SitemapElement

Computes the path relative to the current sitemap.

Returns:

the path relative to the current sitemap.

Throws:

AmetysRepositoryException - if an error occurs.

getSite

public Site getSite()
             throws AmetysRepositoryException

Description copied from interface: SiteAwareAmetysObject

Returns this object's site.

Returns:

this object's site

Throws:

AmetysRepositoryException - if an error occurs.

getSiteName

public String getSiteName()
                   throws AmetysRepositoryException

Description copied from interface: SiteAwareAmetysObject

Returns this object's site name.

Returns:

this object's site name.

Throws:

AmetysRepositoryException - if an error occurs.

getSitemap

public Sitemap getSitemap()
                   throws AmetysRepositoryException

Description copied from interface: SitemapElement

Retrieves the sitemap containing the current sitemap.

Returns:

the sitemap containing the current sitemap.

Throws:

AmetysRepositoryException - if an error occurs.

getSitemapName

public String getSitemapName()
                      throws AmetysRepositoryException

Description copied from interface: SitemapElement

Returns this page's sitemap name

Returns:

this page's sitemap name

Throws:

AmetysRepositoryException - if an error occurs.

getChild

public <A extends AmetysObject> A getChild(String path)
                                    throws AmetysRepositoryException,
UnknownAmetysObjectException

Description copied from interface: TraversableAmetysObject

Retrieves a given child from its relative path. The path cannot be null, empty nor begin with a '/'.

Type Parameters:

A - the actual type of AmetysObject.

Parameters:

path - the path of the child which can contains a position with. [n] if same name sibling is allowed.

Returns:

the child found.

Throws:

AmetysRepositoryException - if an error occurs.

UnknownAmetysObjectException - if the object does not exist.

hasChild

public boolean hasChild(String name)
                 throws AmetysRepositoryException

Description copied from interface: TraversableAmetysObject

Tests if this Object has at least one child with the given name.

Parameters:

name - the name to test. Cannot be null nor empty nor begin with a '/' and it cannot contain '/'.

Returns:

true if the named child exists, false otherwise.

Throws:

AmetysRepositoryException - if an error occurs.

getId

public String getId()
             throws AmetysRepositoryException

Description copied from interface: AmetysObject

Retrieves the unique identifier of this AmetysObject.
It must be unique in the whole repository and must never be null.
It must conform to the URI syntax:
<protocol>://<protocol-specific-part>

Returns:

the unique identifier of this AmetysObject

Throws:

AmetysRepositoryException - if an error occurs.

getName

public String getName()
               throws AmetysRepositoryException

Description copied from interface: AmetysObject

Retrieves the name of the current object.

Returns:

the name.

Throws:

AmetysRepositoryException - if an error occurs.

getParent

public Page getParent()
               throws AmetysRepositoryException

Description copied from interface: AmetysObject

Returns the parent object in the Ametys hierarchy.

Returns:

the parent object or null if current object is the root.

Throws:

AmetysRepositoryException - if an error occurs.

getParentPath

public String getParentPath()
                     throws AmetysRepositoryException

Description copied from interface: AmetysObject

Returns the path of the parent object in the Ametys hierarchy.

Returns:

the path of the parent object.

Throws:

AmetysRepositoryException - if an error occurs.

getDataHolder

public ModelLessDataHolder getDataHolder()

Description copied from interface: DataAwareAmetysObject

Returns the DataHolder of this AmetysObject.

Returns:

the DataHolder of this AmetysObject

getTemplateParametersHolder

public ModelAwareDataHolder getTemplateParametersHolder()
                                                 throws AmetysRepositoryException

Description copied from interface: SitemapElement

Get the view parameters

Returns:

the view parameters

Throws:

AmetysRepositoryException - if an error occurs.