Package org.ametys.plugins.userdirectory.page

Class UserZone

java.lang.Object

org.ametys.plugins.userdirectory.page.UserZone

All Implemented Interfaces:

AmetysObject, DataAwareAmetysObject, ModelLessDataAwareAmetysObject, DataHolder, ModelLessDataHolder, Zone

public class UserZone
extends Object
implements Zone

Zone holding a content.

Field Summary

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

ZONEITEM_DATA_NAME

Constructor Summary

Constructors

Constructor	Description
UserZone(UserPage page, ModelItemTypeExtensionPoint zoneDataTypeExtensionPoint, ModelItemTypeExtensionPoint zoneItemDataTypeExtensionPoint)	Constructor

Method Summary

Modifier and Type	Method	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	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.
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 class java.lang.Object

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

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

equals, 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

Constructor Details

UserZone

public UserZone(UserPage page,
 ModelItemTypeExtensionPoint zoneDataTypeExtensionPoint,
 ModelItemTypeExtensionPoint zoneItemDataTypeExtensionPoint)

Constructor

Parameters:

page - the parent UserPage.

zoneDataTypeExtensionPoint - the extension point with available data types for zones

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

Method Details

getSitemapElement

public SitemapElement getSitemapElement()

Description copied from interface: Zone

Get the parent page of the zone

Specified by:

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

getZoneParametersHolder

public ModelAwareDataHolder getZoneParametersHolder()
                                             throws AmetysRepositoryException

Description copied from interface: Zone

Get the view parameters

Specified by:

getZoneParametersHolder in interface Zone

Returns:

the view parameters

Throws:

AmetysRepositoryException - if an error occurs.