Package org.ametys.web.repository.page

Class StaticZoneItem

java.lang.Object

org.ametys.web.repository.page.StaticZoneItem

All Implemented Interfaces:

AmetysObject, DataAwareAmetysObject, ModelLessDataAwareAmetysObject, DataHolder, ModelLessDataHolder, ZoneItem

public class StaticZoneItem
extends Object
implements ZoneItem

A static zone item. Currently, the static zone item handle only service zone items

Nested Class Summary

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

ZoneItem.ZoneType

Field Summary

Fields

Modifier and Type	Field	Description
protected Map<String,Object>	_parameters	The service parameters
protected Service	_service	The service
protected ModelAwareDataHolder	_serviceParametersHolder	The service parameters holder
protected ZoneItem.ZoneType	_type	The zone type
protected ModelItemTypeExtensionPoint	_zoneItemDataTypeExtensionPoint	The zone item data type extension point

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

SERVICE_PARAMETERS_DATA_NAME

Constructor Summary

Constructors

Constructor	Description
StaticZoneItem(Service service, Map<String,Object> parameters, ModelItemTypeExtensionPoint zoneItemDataTypeExtensionPoint)	The constructor for a zone item containing a service

Method Summary

Modifier and Type	Method	Description
<C extends Content> C	getContent()	Retrieves the content reference.
ModelAwareDataHolder	getContentViewParametersHolder(String contentViewName)	Get the content view parameters for a given view
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.
<A extends AmetysObject> A	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.
ModelAwareDataHolder	getServiceParameters()	Get the service parameters
ModelAwareDataHolder	getServiceViewParametersHolder(String serviceViewName)	Get the service view parameters for a given view
ZoneItem.ZoneType	getType()	Retrieves the type.
Zone	getZone()	Get the parent zone.
ModelAwareDataHolder	getZoneItemParametersHolder()	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, 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, hasDifferences, hasValue, hasValue, hasValueOrEmpty, isMultiple, isMultiple

Methods inherited from interface org.ametys.plugins.repository.data.holder.ModelLessDataHolder

dataToJSON, dataToSAX

Methods inherited from interface org.ametys.web.repository.page.ZoneItem

getViewName

Field Details

_service

protected Service _service

The service

_parameters

protected Map<String,Object> _parameters

The service parameters

_type

protected ZoneItem.ZoneType _type

The zone type

_zoneItemDataTypeExtensionPoint

protected ModelItemTypeExtensionPoint _zoneItemDataTypeExtensionPoint

The zone item data type extension point

_serviceParametersHolder

protected ModelAwareDataHolder _serviceParametersHolder

The service parameters holder

Constructor Details

StaticZoneItem

public StaticZoneItem(Service service,
 Map<String,Object> parameters,
 ModelItemTypeExtensionPoint zoneItemDataTypeExtensionPoint)

The constructor for a zone item containing a service

Parameters:

service - the service

parameters - the service parameters

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

Method Details

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

getContent

public <C extends Content> C getContent()
                                 throws AmetysRepositoryException

Description copied from interface: ZoneItem

Retrieves the content reference.

Specified by:

getContent in interface ZoneItem

Type Parameters:

C - the actual type of Content.

Returns:

the service id.

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.

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.

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

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.

getParent

public <A extends AmetysObject> A getParent()
                                     throws AmetysRepositoryException

Description copied from interface: AmetysObject

Returns the parent object in the Ametys hierarchy.

Specified by:

getParent in interface AmetysObject

Type Parameters:

A - the type of the parent 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.

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

getServiceParameters

public ModelAwareDataHolder 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.

getZoneItemParametersHolder

public ModelAwareDataHolder getZoneItemParametersHolder()
                                                 throws AmetysRepositoryException

Description copied from interface: ZoneItem

Get the view parameters

Specified by:

getZoneItemParametersHolder in interface ZoneItem

Returns:

the view parameters

Throws:

AmetysRepositoryException - if an error occurs.

getContentViewParametersHolder

public ModelAwareDataHolder getContentViewParametersHolder(String contentViewName)
                                                    throws AmetysRepositoryException

Description copied from interface: ZoneItem

Get the content view parameters for a given view

Specified by:

getContentViewParametersHolder in interface ZoneItem

Parameters:

contentViewName - the view name

Returns:

the content view parameters

Throws:

AmetysRepositoryException - if an error occurs.

getServiceViewParametersHolder

public ModelAwareDataHolder getServiceViewParametersHolder(String serviceViewName)
                                                    throws AmetysRepositoryException

Description copied from interface: ZoneItem

Get the service view parameters for a given view

Specified by:

getServiceViewParametersHolder in interface ZoneItem

Parameters:

serviceViewName - the view name

Returns:

the service view parameters

Throws:

AmetysRepositoryException - if an error occurs.