Package org.ametys.web.repository.page

Interface ModifiablePage

All Superinterfaces:

AmetysObject, DataAwareAmetysObject, DataHolder, MetadataAwarePagesContainer, ModelLessDataAwareAmetysObject, ModelLessDataHolder, ModifiableAmetysObject, ModifiableDataHolder, ModifiableModelLessDataAwareAmetysObject, ModifiableModelLessDataHolder, ModifiableTraversableAmetysObject, Page, PagesContainer, RemovableAmetysObject, SiteAwareAmetysObject, TagAwareAmetysObject, TaggableAmetysObject, TraversableAmetysObject

All Known Implementing Classes:

DefaultPage

public interface ModifiablePage
extends Page, ModifiableModelLessDataAwareAmetysObject, ModifiableTraversableAmetysObject, RemovableAmetysObject, TaggableAmetysObject

AmetysObject for storing page informations. <p>

Nested Class Summary

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

Page.LinkType, Page.PageType

Method Summary

Modifier and Type	Method	Description
void	addReferer(String ametysObjectId)	Add a new AmetysObject referencing this page.
ModifiableZone	createZone(String name)	Creates a given zone.
ModifiableModelAwareDataHolder	getTemplateParametersHolder()	Get the view parameters
ModifiableZone	getZone(String name)	Retrieves a given zone.
AmetysObjectIterable<ModifiableZone>	getZones()	Retrieves the zones.
void	removeReferer(String ametysObjectId)	Removes an AmetysObject referencing this page.
void	setLongTitle(String title)	Set the long title.
void	setSitemapName(String sitemapName)	Set the sitemap name.
void	setSiteName(String siteName)	Set the site name.
void	setTemplate(String template)	Set the template name.
void	setTitle(String title)	Set the title.
void	setType(Page.PageType type)	Set the type.
void	setURL(Page.LinkType type, String url)	Set the linked URL.
void	setVisible(boolean isVisible)	Set the visibility of the page

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, dataToSAX, dataToSAX, getDataNames, getRepositoryData

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

dataToSAX, getComposite, getParentDataHolder, getRootDataHolder, getType, getValue, getValue, getValueOfType, getValueOfType, hasNonEmptyValue, hasValue, isMultiple

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

dataToSAX, hasNonEmptyValue, hasValue

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

needsSave, rename, revertChanges, saveChanges

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

getComposite, getComposite, getDataHolder, getParentDataHolder, getRepositoryData, getRootDataHolder, removeValue, setValue, setValue, synchronizeValues

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

createChild

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

getDepth, getLongTitle, getReferers, getRootAttachments, getTemplate, getTitle, getType, getURL, getURLType, hasZone, isVisible

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

getChildPageAt, getChildrenPages, getChildrenPages, getPathInSitemap, getSitemap, getSitemapName

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

remove

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

getSite, getSiteName

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

getTags

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

tag, untag

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

getChild, getChildAt, getChildPosition, getChildren, hasChild

Method Detail

setTitle

void setTitle(String title)
       throws AmetysRepositoryException

Set the title.

Parameters:

title - the title.

Throws:

AmetysRepositoryException - if an error occurs.

setLongTitle

void setLongTitle(String title)
           throws AmetysRepositoryException

Set the long title.

Parameters:

title - the title.

Throws:

AmetysRepositoryException - if an error occurs.

setSitemapName

void setSitemapName(String sitemapName)
             throws AmetysRepositoryException

Set the sitemap name.

Parameters:

sitemapName - the sitemap name.

Throws:

AmetysRepositoryException - if an error occurs.

setSiteName

void setSiteName(String siteName)
          throws AmetysRepositoryException

Set the site name.

Parameters:

siteName - the site name.

Throws:

AmetysRepositoryException - if an error occurs.

setType

void setType(Page.PageType type)
      throws AmetysRepositoryException

Set the type.

Parameters:

type - the type.

Throws:

AmetysRepositoryException - if an error occurs.

See Also:

Page.PageType

setURL

void setURL(Page.LinkType type,
            String url)
     throws AmetysRepositoryException

Set the linked URL.

Parameters:

type - the type of link

url - the linked URL (depending on the type)

Throws:

AmetysRepositoryException - if an error occurs.

setTemplate

void setTemplate(String template)
          throws AmetysRepositoryException

Set the template name.

Parameters:

template - the template name.

Throws:

AmetysRepositoryException - if an error occurs.

getZones

AmetysObjectIterable<ModifiableZone> getZones()
                                       throws AmetysRepositoryException

Retrieves the zones.

Specified by:

getZones in interface Page

Returns:

the zones.

Throws:

AmetysRepositoryException - if an error occurs.

getZone

ModifiableZone getZone(String name)
                throws UnknownZoneException,
                       AmetysRepositoryException

Retrieves a given zone.

Specified by:

getZone in interface Page

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.

createZone

ModifiableZone createZone(String name)
                   throws AmetysRepositoryException

Creates a given zone.

Parameters:

name - the name of the zone.

Returns:

the given zone.

Throws:

AmetysRepositoryException - if an error occurs.

addReferer

void addReferer(String ametysObjectId)
         throws AmetysRepositoryException

Add a new AmetysObject referencing this page.

Parameters:

ametysObjectId - the AmetysObject ids referencing this page.

Throws:

AmetysRepositoryException - if an error occurs.

removeReferer

void removeReferer(String ametysObjectId)
            throws AmetysRepositoryException

Removes an AmetysObject referencing this page.

Parameters:

ametysObjectId - the AmetysObject ids referencing this page.

Throws:

AmetysRepositoryException - if an error occurs.

setVisible

void setVisible(boolean isVisible)
         throws AmetysRepositoryException

Set the visibility of the page

Parameters:

isVisible - the page visibility.

Throws:

AmetysRepositoryException - if an error occurs.

getTemplateParametersHolder

ModifiableModelAwareDataHolder getTemplateParametersHolder()
                                                    throws AmetysRepositoryException

Get the view parameters

Specified by:

getTemplateParametersHolder in interface Page

Returns:

the view parameters

Throws:

AmetysRepositoryException - if an error occurs.