org.ametys.plugins.odfweb.repository

Class FirstLevelZone

java.lang.Object

org.ametys.plugins.odfweb.repository.FirstLevelZone

All Implemented Interfaces:

AmetysObject, DataAwareAmetysObject, ModelLessDataAwareAmetysObject, DataHolder, ModelLessDataHolder, Zone

public class FirstLevelZone
extends Object
implements Zone

Zone holding a Program.

Field Summary

Fields

Modifier and Type	Field and Description
private FirstLevelPage	_page
private ServiceExtensionPoint	_serviceExtensionPoint
private AbstractThreadSafeComponentExtensionPoint<RepositoryModelItemType>	_zoneDataTypeExtensionPoint
private AbstractThreadSafeComponentExtensionPoint<RepositoryModelItemType>	_zoneItemDataTypeExtensionPoint

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

ZONEITEM_DATA_NAME

Constructor Summary

Constructors

Constructor and Description
FirstLevelZone(FirstLevelPage page, AbstractThreadSafeComponentExtensionPoint<RepositoryModelItemType> zoneDataTypeExtensionPoint, ServiceExtensionPoint serviceExtensionPoint, AbstractThreadSafeComponentExtensionPoint<RepositoryModelItemType> zoneItemDataTypeExtensionPoint) Constructor

Method Summary

Modifier and Type	Method and Description
ModelLessDataHolder	getDataHolder() Returns the DataHolder of this AmetysObject.
String	getId() Retrieves the unique identifier of this AmetysObject. It must be unique in the whole repository and must never be null. It must conform to the URI syntax: <protocol>://<protocol-specific-part>
String	getName() Retrieves the name of the current object.
Page	getPage() Get the parent page of the zone
Page	getParent() Returns the parent object in the Ametys hierarchy.
String	getParentPath() Returns the path of the parent object in the Ametys hierarchy.
String	getPath() Retrieves the path of the current object.
AmetysObjectIterable<? extends ZoneItem>	getZoneItems() Retrieve the list of used zone items

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

getComposite, getRepeater, getType, getValue, getValue, getValueOfType, getValueOfType, hasValue, isMultiple

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

copyTo, getDataNames

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

equals, hashCode

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

toSAX, toSAX

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

dataToSAX, dataToSAX, dataToSAX, dataToSAX

Field Detail

_page

private FirstLevelPage _page

_zoneDataTypeExtensionPoint

private AbstractThreadSafeComponentExtensionPoint<RepositoryModelItemType> _zoneDataTypeExtensionPoint

_serviceExtensionPoint

private ServiceExtensionPoint _serviceExtensionPoint

_zoneItemDataTypeExtensionPoint

private AbstractThreadSafeComponentExtensionPoint<RepositoryModelItemType> _zoneItemDataTypeExtensionPoint

Constructor Detail

FirstLevelZone

public FirstLevelZone(FirstLevelPage page,
                      AbstractThreadSafeComponentExtensionPoint<RepositoryModelItemType> zoneDataTypeExtensionPoint,
                      ServiceExtensionPoint serviceExtensionPoint,
                      AbstractThreadSafeComponentExtensionPoint<RepositoryModelItemType> zoneItemDataTypeExtensionPoint)

Constructor

Parameters:

page - the parent FirstLevelPage.

zoneDataTypeExtensionPoint - the extension point with available data types for zones

serviceExtensionPoint - the service extension point

zoneItemDataTypeExtensionPoint - the extension point with available data types for zone items

Method Detail

getPage

public Page getPage()

Description copied from interface: Zone

Get the parent page of the zone

Specified by:

getPage in interface Zone

Returns:

The parent page. Cannot be null.

getZoneItems

public AmetysObjectIterable<? extends ZoneItem> getZoneItems()
                                                      throws AmetysRepositoryException

Description copied from interface: Zone

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

getDataHolder

public ModelLessDataHolder getDataHolder()

Description copied from interface: DataAwareAmetysObject

Returns the DataHolder of this AmetysObject.

Specified by:

getDataHolder in interface DataAwareAmetysObject

Specified by:

getDataHolder in interface ModelLessDataAwareAmetysObject

Returns:

the DataHolder of this AmetysObject

getId

public String getId()
             throws AmetysRepositoryException

Description copied from interface: AmetysObject

Retrieves the unique identifier of this AmetysObject.
It must be unique in the whole repository and must never be null.
It must conform to the URI syntax:
<protocol>://<protocol-specific-part>

Specified by:

getId in interface AmetysObject

Returns:

the unique identifier of this AmetysObject

Throws:

AmetysRepositoryException - if an error occurs.

getName

public String getName()
               throws AmetysRepositoryException

Description copied from interface: AmetysObject

Retrieves the name of the current object.

Specified by:

getName in interface AmetysObject

Returns:

the name.

Throws:

AmetysRepositoryException - if an error occurs.

getParent

public Page getParent()
               throws AmetysRepositoryException

Description copied from interface: AmetysObject

Returns the parent object in the Ametys hierarchy.

Specified by:

getParent in interface AmetysObject

Returns:

the parent object or null if current object is the root.

Throws:

AmetysRepositoryException - if an error occurs.

getParentPath

public String getParentPath()
                     throws AmetysRepositoryException

Description copied from interface: AmetysObject

Returns the path of the parent object in the Ametys hierarchy.

Specified by:

getParentPath in interface AmetysObject

Returns:

the path of the parent object.

Throws:

AmetysRepositoryException - if an error occurs.

getPath

public String getPath()
               throws AmetysRepositoryException

Description copied from interface: AmetysObject

Retrieves the path of the current object.

Specified by:

getPath in interface AmetysObject

Returns:

the path.

Throws:

AmetysRepositoryException - if an error occurs.