org.ametys.web.repository.page

Interface ZoneItem

All Superinterfaces:

AmetysObject, DataAwareAmetysObject, DataHolder, ModelLessDataAwareAmetysObject, ModelLessDataHolder

All Known Subinterfaces:

ModifiableZoneItem

All Known Implementing Classes:

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

public interface ZoneItem
extends ModelLessDataAwareAmetysObject

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.

Field Summary

Fields

Modifier and Type	Field and Description
static String	SERVICE_PARAMETERS_DATA_NAME Constant for the name of the data containing the service parameters.

Method Summary

Modifier and Type	Method and Description
<C extends Content> C	getContent() Retrieves the content reference.
String	getMetadataSetName() Deprecated. Use getViewName() instead
String	getServiceId() Retrieves the service id.
ModelAwareDataHolder	getServiceParameters() Get the service parameters
ZoneItem.ZoneType	getType() Retrieves the type.
default String	getViewName() Get the name of the view to render the Content with.
Zone	getZone() Get the parent zone.

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

getComposite, getDataHolder, 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, getId, getName, getParent, getParentPath, getPath, 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

SERVICE_PARAMETERS_DATA_NAME

static final String SERVICE_PARAMETERS_DATA_NAME

Constant for the name of the data containing the service parameters.

See Also:

Constant Field Values

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

@Deprecated
String getMetadataSetName()
                               throws AmetysRepositoryException

Deprecated. Use getViewName() instead

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.

getViewName

default String getViewName()
                    throws AmetysRepositoryException

Get the name of the view 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 view name, or null if not set.

Throws:

AmetysRepositoryException - if an error occurs. TODO NEWATTRIBUTEAPI_SERVICE: remove the default implementation when all zone items implement the method

getServiceId

String getServiceId()
             throws AmetysRepositoryException

Retrieves the service id.

Returns:

the service id.

Throws:

AmetysRepositoryException - if an error occurs.

getServiceParameters

ModelAwareDataHolder 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