Package org.ametys.web.repository

Interface SiteAwareAmetysObject

All Superinterfaces:

AmetysObject, DataHolder

All Known Subinterfaces:

LockablePage, ModifiablePage, ModifiableSiteAwareAmetysObject, ModifiableSitemapElement, ModifiableWebContent, Page, SharedContent, SitemapElement, WebContent

All Known Implementing Classes:

AbstractConfigurableVirtualPage, AbstractOdfPage, AbstractProgramItemPage, AbstractSitemapElement, CoursePage, DefaultDefinition, DefaultLink, DefaultPage, DefaultSharedContent, DefaultTheme, DefaultTheme, DefaultWebContent, File, FirstLevelPage, Folder, Form, FormDirectory, FormQuestion, ModifiableDefaultWebContent, OrgUnitPage, ProgramPage, Project, RedirectPage, SecondLevelPage, Sitemap, Survey, TransitionalPage, UGCPage, UGCTransitionalPage, UserPage

public interface SiteAwareAmetysObject
extends AmetysObject

An ametys object that is aware of its Site.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	METADATA_SITE	Constants for site metadata.

Method Summary

Modifier and Type	Method	Description
Site	getSite()	Returns this object's site.
String	getSiteName()	Returns this object's site name.

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.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

Field Details

METADATA_SITE

static final String METADATA_SITE

Constants for site metadata.

See Also:

• Constant Field Values

Method Details

getSiteName

String getSiteName()
            throws AmetysRepositoryException

Returns this object's site name.

Returns:

this object's site name.

Throws:

AmetysRepositoryException - if an error occurs.

getSite

Site getSite()
      throws AmetysRepositoryException

Returns this object's site.

Returns:

this object's site

Throws:

AmetysRepositoryException - if an error occurs.