Package org.ametys.web.repository.page

Interface Zone

All Superinterfaces:

AmetysObject, DataAwareAmetysObject, DataHolder, ModelLessDataAwareAmetysObject, ModelLessDataHolder

All Known Subinterfaces:

ModifiableZone

All Known Implementing Classes:

CourseZone, DefaultZone, FirstLevelZone, OrgUnitZone, ProgramZone, SecondLevelZone, TransitionalZone, UGCTransitionalZone, UGCZone, UserZone

public interface Zone
extends ModelLessDataAwareAmetysObject

An Zone is a part of a page where contents or services can be rendered. It is composed of ZoneItems

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ZONEITEM_DATA_NAME	Constant for the name of the data containing the zone item

Method Summary

Modifier and Type	Method	Description
SitemapElement	getSitemapElement()	Get the parent page of the zone
AmetysObjectIterable<? extends ZoneItem>	getZoneItems()	Retrieve the list of used zone items
ModelAwareDataHolder	getZoneParametersHolder()	Get the view parameters

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, 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, hasValue, hasValue, hasValueOrEmpty, isMultiple, isMultiple

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

dataToJSON, dataToSAX

Field Details

ZONEITEM_DATA_NAME

static final String ZONEITEM_DATA_NAME

Constant for the name of the data containing the zone item

See Also:

• Constant Field Values

Method Details

getZoneItems

AmetysObjectIterable<? extends ZoneItem> getZoneItems()
                                               throws AmetysRepositoryException

Retrieve the list of used zone items

Returns:

The list of zone items. Cannot be null.

Throws:

AmetysRepositoryException - if an error occured

getSitemapElement

SitemapElement getSitemapElement()

Get the parent page of the zone

Returns:

The parent page. Cannot be null.

getZoneParametersHolder

ModelAwareDataHolder getZoneParametersHolder()
                                      throws AmetysRepositoryException

Get the view parameters

Returns:

the view parameters

Throws:

AmetysRepositoryException - if an error occurs.