org.ametys.plugins.odfweb.repository

Class FirstLevelZoneItem

java.lang.Object

org.ametys.plugins.odfweb.repository.FirstLevelZoneItem

All Implemented Interfaces:

AmetysObject, MetadataAwareAmetysObject, ZoneItem

public class FirstLevelZoneItem
extends Object
implements ZoneItem

ZoneItem holding a Sitemap service

Nested Class Summary

Nested classes/interfaces inherited from interface org.ametys.web.repository.page.ZoneItem

ZoneItem.ZoneType

Field Summary

Fields

Modifier and Type	Field and Description
private FirstLevelPage	_page

Constructor Summary

Constructors

Constructor and Description
FirstLevelZoneItem(FirstLevelPage page) Constructor.

Method Summary

Modifier and Type	Method and Description
Program	getContent() Retrieves the content reference.
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	getMetadataSetName() Get the name of the metadata set to render the Content with.
String	getName() Retrieves the name of the current object.
FirstLevelZone	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.
String	getServiceId() Retrieves the service id.
CompositeMetadata	getServiceParameters() Get the service parameters
ZoneItem.ZoneType	getType() Retrieves the type.
Zone	getZone() Get the parent zone.

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

FirstLevelZoneItem

public FirstLevelZoneItem(FirstLevelPage page)

Constructor.

Parameters:

page - the parent FirstLevelPage.

Method Detail

getContent

public Program getContent()
                   throws AmetysRepositoryException

Description copied from interface: ZoneItem

Retrieves the content reference.

Specified by:

getContent in interface ZoneItem

Returns:

the service id.

Throws:

AmetysRepositoryException - if an error occurs.

getMetadataSetName

public String getMetadataSetName()
                          throws AmetysRepositoryException

Description copied from interface: ZoneItem

Get the name of the metadata set to render the Content with. It only makes sense if the ZoneItem is a Content reference.
If null is returned, in most cases, "main" should be assumed.

Specified by:

getMetadataSetName in interface ZoneItem

Returns:

the metadata set name, or null if not set.

Throws:

AmetysRepositoryException - if an error occurs.

getServiceId

public String getServiceId()
                    throws AmetysRepositoryException

Description copied from interface: ZoneItem

Retrieves the service id.

Specified by:

getServiceId in interface ZoneItem

Returns:

the service id.

Throws:

AmetysRepositoryException - if an error occurs.

getServiceParameters

public CompositeMetadata getServiceParameters()
                                       throws AmetysRepositoryException

Description copied from interface: ZoneItem

Get the service parameters

Specified by:

getServiceParameters in interface ZoneItem

Returns:

the service parameters

Throws:

AmetysRepositoryException - if an error occurs.

getType

public ZoneItem.ZoneType getType()
                          throws AmetysRepositoryException

Description copied from interface: ZoneItem

Retrieves the type.

Specified by:

getType in interface ZoneItem

Returns:

the type.

Throws:

AmetysRepositoryException - if an error occurs.

See Also:

ZoneItem.ZoneType

getZone

public Zone getZone()

Description copied from interface: ZoneItem

Get the parent zone.

Specified by:

getZone in interface ZoneItem

Returns:

the parent zone of the zone item. cannot be null

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