org.ametys.plugins.odfweb.repository

Class FirstLevelZone

java.lang.Object

org.ametys.plugins.odfweb.repository.FirstLevelZone

All Implemented Interfaces:

AmetysObject, MetadataAwareAmetysObject, Zone

public class FirstLevelZone
extends Object
implements Zone

Zone holding a Program.

Field Summary

Fields

Modifier and Type	Field and Description
private FirstLevelPage	_page

Constructor Summary

Constructors

Constructor and Description
FirstLevelZone(FirstLevelPage page) Constructor

Method Summary

Modifier and Type	Method and Description
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>
CompositeMetadata	getMetadataHolder() Returns the root CompositeMetadata of this AmetysObject.
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.AmetysObject

equals, hashCode

Field Detail

_page

private FirstLevelPage _page

Constructor Detail

FirstLevelZone

public FirstLevelZone(FirstLevelPage page)

Constructor

Parameters:

page - the parent FirstLevelPage.

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

getMetadataHolder

public CompositeMetadata getMetadataHolder()

Description copied from interface: MetadataAwareAmetysObject

Returns the root CompositeMetadata of this AmetysObject.

Specified by:

getMetadataHolder in interface MetadataAwareAmetysObject

Returns:

the root CompositeMetadata 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.