Package org.ametys.plugins.odfweb.repository

Class ProgramPage

java.lang.Object

org.ametys.plugins.repository.AbstractAmetysObject

org.ametys.web.repository.page.virtual.AbstractConfigurableVirtualPage<ProgramPageFactory>

org.ametys.plugins.odfweb.repository.AbstractOdfPage<ProgramPageFactory>

org.ametys.plugins.odfweb.repository.AbstractProgramItemPage<ProgramPageFactory>

org.ametys.plugins.odfweb.repository.ProgramPage

All Implemented Interfaces:

AmetysObject, DataHolder, TagAwareAmetysObject, TraversableAmetysObject, Page, SitemapElement, SiteAwareAmetysObject

public class ProgramPage
extends AbstractProgramItemPage<ProgramPageFactory>

Page representing a Program or a SubProgram.

Nested Class Summary

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

Page.LinkType, Page.PageType

Field Summary

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

INDEXABLE_CHILDREN

Fields inherited from class org.ametys.web.repository.page.virtual.AbstractConfigurableVirtualPage

_configuration, _factory, _root, _scheme

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

METADATA_SITE

Constructor Summary

Constructors

Constructor	Description
ProgramPage(Page root, VirtualPageConfiguration configuration, ProgramPageFactory factory, AbstractProgram program, String path, Program parentProgram, Page parentPage)	Constructor for program page holding a Program or SubProgram

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.
AbstractProgram	getContent()	Get the page's content
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.
AbstractProgram	getProgram()	Returns the associated Program or SubProgram.
protected ProgramItem	getProgramItem()	Get the program item wrapped in this page
String	getTitle()	Retrieves the title.
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.AbstractProgramItemPage

getChildPageAt, getChildren, getChildrenPages, getOdfPath, setCurrentEducationalPaths

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

isIndexable

Methods inherited from class org.ametys.web.repository.page.virtual.AbstractConfigurableVirtualPage

getDataHolder, getPath, getReferers, getRootAttachments, getScheme, getSite, getSitemap, getSitemapName, getSiteName, getTags, getTemplate, getTemplateParametersHolder, getType, getURL, getURLType, getZone, getZoneConfiguration, getZones, hasZone, isVisible

Methods inherited from class org.ametys.plugins.repository.AbstractAmetysObject

dataToJSON, dataToJSON, dataToSAX, dataToSAX, equals, getComposite, getDataNames, getModelItemTypeExtensionPoint, getParentDataHolder, getRepositoryData, getRootDataHolder, getType, getValue, getValueOfType, getValueOfTypeOrDefault, getValueOrDefault, hasDifferences, hashCode, hasValue, hasValue, hasValueOrEmpty, isMultiple, isMultiple, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

equals, hashCode

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

copyTo, copyTo, dataToJSON, dataToJSON, dataToJSON, dataToJSON, dataToSAX, dataToSAX, dataToSAX, dataToSAX, getComposite, getDataNames, getModelItemTypeExtensionPoint, getParentDataHolder, getRepositoryData, getRootDataHolder, getType, getValue, getValueOfType, getValueOfTypeOrDefault, getValueOrDefault, hasDifferences, hasValue, hasValue, hasValueOrEmpty, isMultiple, isMultiple

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

getChildAt, getChildPosition

Constructor Details

ProgramPage

public ProgramPage(Page root,
 VirtualPageConfiguration configuration,
 ProgramPageFactory factory,
 AbstractProgram program,
 String path,
 Program parentProgram,
 Page parentPage)

Constructor for program page holding a Program or SubProgram

Parameters:

root - the ODF root page.

configuration - The program virtual page's configuration

factory - The factory

program - the program or subprogram.

path - The path from the virtual second level page. Can be null if abstract program is a Program

parentProgram - the parent program in case of a subprogram, null otherwise

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

Method Details

getProgram

public AbstractProgram getProgram()

Returns the associated Program or SubProgram.

Returns:

the associated Program or SubProgram.

getProgramItem

protected ProgramItem getProgramItem()

Description copied from class: AbstractProgramItemPage

Get the program item wrapped in this page

Specified by:

getProgramItem in class AbstractProgramItemPage<ProgramPageFactory>

Returns:

the program item

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.

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.

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.

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.

getContent

public AbstractProgram getContent()

Description copied from class: AbstractConfigurableVirtualPage

Get the page's content

Overrides:

getContent in class AbstractConfigurableVirtualPage<ProgramPageFactory>

Returns:

The content