Package org.ametys.web.repository.page

Interface ModifiableZone

All Superinterfaces:

AmetysObject, DataHolder, ModifiableAmetysObject, ModifiableDataHolder, RemovableAmetysObject, Zone

All Known Implementing Classes:

DefaultZone

public interface ModifiableZone
extends Zone, ModifiableAmetysObject, RemovableAmetysObject

A zone that is modifiable

Field Summary

Fields inherited from interface org.ametys.web.repository.page.Zone

ZONEITEM_DATA_NAME

Method Summary

Modifier and Type	Method	Description
ModifiableZoneItem	addZoneItem()	Add a new zone item
AmetysObjectIterable<ModifiableZoneItem>	getZoneItems()	Retrieve the list of used zone items
ModifiableModelAwareDataHolder	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.holder.DataHolder

copyTo, copyTo, dataToJSON, dataToJSON, dataToJSON, dataToJSON, dataToSAX, dataToSAX, dataToSAX, dataToSAX, getDataNames, getModelItemTypeExtensionPoint, getType, getValue, getValueOfType, getValueOfTypeOrDefault, getValueOrDefault, hasDifferences, hasValue, hasValue, hasValueOrEmpty, isMultiple, isMultiple

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

needsSave, rename, revertChanges, saveChanges

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

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

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

remove

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

getSitemapElement

Method Details

addZoneItem

ModifiableZoneItem addZoneItem()
                        throws AmetysRepositoryException

Add a new zone item

Returns:

The zone item created

Throws:

AmetysRepositoryException - If an error occured

getZoneItems

AmetysObjectIterable<ModifiableZoneItem> getZoneItems()
                                               throws AmetysRepositoryException

Retrieve the list of used zone items

Specified by:

getZoneItems in interface Zone

Returns:

The list of zone items. Cannot be null.

Throws:

AmetysRepositoryException - if an error occured

getZoneParametersHolder

ModifiableModelAwareDataHolder getZoneParametersHolder()
                                                throws AmetysRepositoryException

Get the view parameters

Specified by:

getZoneParametersHolder in interface Zone

Returns:

the view parameters

Throws:

AmetysRepositoryException - if an error occurs.