Package org.ametys.plugins.userdirectory.page

Class TransitionalZoneItem

java.lang.Object

org.ametys.plugins.userdirectory.page.TransitionalZoneItem

All Implemented Interfaces:

AmetysObject, DataAwareAmetysObject, ModelLessDataAwareAmetysObject, DataHolder, ModelLessDataHolder, ZoneItem

public class TransitionalZoneItem
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 inherited from interface org.ametys.web.repository.page.ZoneItem

SERVICE_PARAMETERS_DATA_NAME

Constructor Summary

Constructors

Constructor	Description
TransitionalZoneItem(TransitionalPage page, ModelItemTypeExtensionPoint zoneDataTypeExtensionPoint, ServiceExtensionPoint serviceExtensionPoint, ModelItemTypeExtensionPoint zoneItemDataTypeExtensionPoint)	Constructor.

Method Summary

Modifier and Type	Method	Description
Content	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.
TransitionalZone	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.
String	getViewName()	Get the name of the view to render the Content with.
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, 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, hasValue, hasValue, hasValueOrEmpty, isMultiple, isMultiple

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

dataToJSON, dataToSAX

Constructor Details

TransitionalZoneItem

public TransitionalZoneItem(TransitionalPage page,
 ModelItemTypeExtensionPoint zoneDataTypeExtensionPoint,
 ServiceExtensionPoint serviceExtensionPoint,
 ModelItemTypeExtensionPoint zoneItemDataTypeExtensionPoint)

Constructor.

Parameters:

page - the parent TransitionalPage.

zoneDataTypeExtensionPoint - the extension point with available data types for zones

serviceExtensionPoint - the service extension point

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

Method Details

getContent

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

getViewName

public String getViewName()
                   throws AmetysRepositoryException

Description copied from interface: ZoneItem

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.

Specified by:

getViewName in interface ZoneItem

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

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

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

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

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

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.