Package org.ametys.plugins.userdirectory.page

Class UserZoneItem

java.lang.Object

org.ametys.plugins.repository.AbstractAmetysObject

org.ametys.web.repository.page.virtual.ConfigurableVirtualZoneItem

org.ametys.plugins.userdirectory.page.UserZoneItem

All Implemented Interfaces:

AmetysObject, DataHolder, ZoneItem

public class UserZoneItem
extends ConfigurableVirtualZoneItem

ZoneItem holding a content.

Nested Class Summary

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

ZoneItem.ZoneType

Field Summary

Fields inherited from class org.ametys.web.repository.page.virtual.ConfigurableVirtualZoneItem

_configuration, _name, _page, _zoneConfiguration, _zoneType

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

SERVICE_PARAMETERS_DATA_NAME

Constructor Summary

Constructors

Constructor	Description
UserZoneItem(AbstractConfigurableVirtualPage page, VirtualZoneItemConfiguration configuration, String scheme, ConfigurableVirtualZoneItemFactory factory)	Constructor.

Method Summary

Modifier and Type	Method	Description
String	getViewName()	Get the name of the view to render the Content with.

Methods inherited from class org.ametys.web.repository.page.virtual.ConfigurableVirtualZoneItem

getContent, getContentViewParametersHolder, getDataHolder, getId, getName, getParent, getParentPath, getPath, getServiceId, getServiceParameters, getServiceViewParametersHolder, getType, getZone, getZoneItemParametersHolder

Methods inherited from class org.ametys.plugins.repository.AbstractAmetysObject

dataToJSON, dataToJSON, dataToSAX, dataToSAX, equals, getComposite, getDataNames, getModelItemTypeExtensionPoint, getParentDataHolder, getRepositoryData, getRootDataHolder, getType, getValue, getValueOfType, getValueOfTypeOrDefault, getValueOrDefault, hasDifferences, hashCode, hasValue, hasValue, hasValueOrEmpty, isMultiple, isMultiple, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

equals, hashCode

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

copyTo, copyTo, dataToJSON, dataToJSON, dataToJSON, dataToJSON, dataToSAX, dataToSAX, dataToSAX, dataToSAX, getComposite, getDataNames, getModelItemTypeExtensionPoint, getParentDataHolder, getRepositoryData, getRootDataHolder, getType, getValue, getValueOfType, getValueOfTypeOrDefault, getValueOrDefault, hasDifferences, hasValue, hasValue, hasValueOrEmpty, isMultiple, isMultiple

Constructor Details

UserZoneItem

public UserZoneItem(AbstractConfigurableVirtualPage page,
 VirtualZoneItemConfiguration configuration,
 String scheme,
 ConfigurableVirtualZoneItemFactory factory)

Constructor.

Parameters:

page - the parent UserPage.

configuration - The configuration

scheme - The scheme

factory - The factory

Method Details

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

Overrides:

getViewName in class ConfigurableVirtualZoneItem

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