org.ametys.web.repository.page

Interface ZoneItem

All Superinterfaces:

AmetysObject, MetadataAwareAmetysObject

All Known Subinterfaces:

ModifiableZoneItem

All Known Implementing Classes:

CourseZoneItem, DefaultZoneItem, FirstLevelZoneItem, OrgUnitZoneItem, PostListZoneItem, PostZoneItem, ProgramZoneItem, SecondLevelZoneItem, StaticZoneItem, TransitionalZoneItem, UserZoneItem

public interface ZoneItem
extends MetadataAwareAmetysObject

A ZoneItem is an ordered part of Zone It can be a content ref or a service

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	ZoneItem.ZoneType Type of an zone.

Method Summary

Modifier and Type	Method and Description
<C extends Content> C	getContent() Retrieves the content reference.
String	getMetadataSetName() Get the name of the metadata set to render the Content with.
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 interface org.ametys.plugins.repository.metadata.MetadataAwareAmetysObject

getMetadataHolder

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

equals, getId, getName, getParent, getParentPath, getPath, hashCode

Method Detail

getType

ZoneItem.ZoneType getType()
                   throws AmetysRepositoryException

Retrieves the type.

Returns:

the type.

Throws:

AmetysRepositoryException - if an error occurs.

See Also:

ZoneItem.ZoneType

getContent

<C extends Content> C getContent()
                          throws AmetysRepositoryException

Retrieves the content reference.

Type Parameters:

C - the actual type of Content.

Returns:

the service id.

Throws:

AmetysRepositoryException - if an error occurs.

getMetadataSetName

String getMetadataSetName()
                   throws AmetysRepositoryException

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.

Returns:

the metadata set name, or null if not set.

Throws:

AmetysRepositoryException - if an error occurs.

getServiceId

String getServiceId()
             throws AmetysRepositoryException

Retrieves the service id.

Returns:

the service id.

Throws:

AmetysRepositoryException - if an error occurs.

getServiceParameters

CompositeMetadata getServiceParameters()
                                throws AmetysRepositoryException

Get the service parameters

Returns:

the service parameters

Throws:

AmetysRepositoryException - if an error occurs.

getZone

Zone getZone()

Get the parent zone.

Returns:

the parent zone of the zone item. cannot be null