Package org.ametys.web.repository.page

Interface ModifiableZone

All Superinterfaces:

AmetysObject, DataAwareAmetysObject, DataHolder, ModelLessDataAwareAmetysObject, ModelLessDataHolder, ModifiableAmetysObject, ModifiableDataHolder, ModifiableModelLessDataAwareAmetysObject, ModifiableModelLessDataHolder, RemovableAmetysObject, Zone

All Known Implementing Classes:

DefaultZone

public interface ModifiableZone
extends Zone, ModifiableModelLessDataAwareAmetysObject, 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.ametysobject.DataAwareAmetysObject

copyTo, dataToJSON, dataToJSON, dataToSAX, dataToSAX, getDataNames, getRepositoryData

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

dataToJSON, dataToSAX, getComposite, 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, hasValue, hasValueOrEmpty

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