Package org.ametys.web.repository.page.virtual

Class ConfigurableVirtualZoneItemFactory

java.lang.Object

org.ametys.web.repository.page.virtual.ConfigurableVirtualZoneItemFactory

All Implemented Interfaces:

AmetysObjectFactory<ConfigurableVirtualZoneItem>, Component, Configurable, Serviceable

Direct Known Subclasses:

UserZoneItemFactory

public class ConfigurableVirtualZoneItemFactory
extends Object
implements AmetysObjectFactory<ConfigurableVirtualZoneItem>, Serviceable, Configurable

The factory for configurable zone item

Field Summary

Fields

Modifier and Type	Field	Description
protected AmetysObjectFactoryExtensionPoint	_ametysObjectFactoryEP	The ametys object factory extension point
protected I18nUtils	_i18nUtils	the i18n utils component
protected ServiceManager	_manager	The service manager
protected ModelItemTypeExtensionPoint	_pageDataTypeExtensionPoint	The model item ep
protected AmetysObjectResolver	_resolver	The AmetysObject resolver
protected String	_scheme	The scheme for the ametys object prefix
protected ServiceExtensionPoint	_serviceExtensionPoint	The service ep
protected String	_zoneFactoryId	The zone factory id
static final String	ROLE	The avalon role

Constructor Summary

Constructors

Constructor	Description
ConfigurableVirtualZoneItemFactory()

Method Summary

Modifier and Type	Method	Description
void	configure(Configuration configuration)
ConfigurableVirtualZoneItem	createZoneItem(AbstractConfigurableVirtualPage page, String zoneName, String zoneItemId)	Create a zone item with its page, zoneName and id
ConfigurableVirtualZoneItem	getAmetysObjectById(String id)	Retrieves an AmetysObject, given its id. Id are like <protocol>://<protocol-specific-part>.
I18nUtils	getI18nUtils()	Get the i18n utils
String	getScheme()	Returns the protocol of this factory, used to construct unique ids.
ServiceExtensionPoint	getServiceExtensionPoint()	Get the service extension point
ConfigurableVirtualZoneFactory	getZoneFactory()	Get the Configurable virtual zone's factory
ModelItemTypeExtensionPoint	getZoneItemDataTypeExtensionPoint()	Get the zone item data type extension point
boolean	hasAmetysObjectForId(String id)	Return true if the specified id correspond to an existing AmetysObject.
void	service(ServiceManager manager)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

ROLE

public static final String ROLE

The avalon role

_manager

protected ServiceManager _manager

The service manager

_resolver

protected AmetysObjectResolver _resolver

The AmetysObject resolver

_ametysObjectFactoryEP

protected AmetysObjectFactoryExtensionPoint _ametysObjectFactoryEP

The ametys object factory extension point

_i18nUtils

protected I18nUtils _i18nUtils

the i18n utils component

_pageDataTypeExtensionPoint

protected ModelItemTypeExtensionPoint _pageDataTypeExtensionPoint

The model item ep

_serviceExtensionPoint

protected ServiceExtensionPoint _serviceExtensionPoint

The service ep

_scheme

protected String _scheme

The scheme for the ametys object prefix

_zoneFactoryId

protected String _zoneFactoryId

The zone factory id

Constructor Details

ConfigurableVirtualZoneItemFactory

public ConfigurableVirtualZoneItemFactory()

Method Details

service

public void service(ServiceManager manager)
             throws ServiceException

Specified by:

service in interface Serviceable

Throws:

ServiceException

configure

public void configure(Configuration configuration)
               throws ConfigurationException

Specified by:

configure in interface Configurable

Throws:

ConfigurationException

createZoneItem

public ConfigurableVirtualZoneItem createZoneItem(AbstractConfigurableVirtualPage page,
 String zoneName,
 String zoneItemId)

Create a zone item with its page, zoneName and id

Parameters:

page - The zone item's page

zoneName - The zone's name

zoneItemId - The zone item's id

Returns:

The created ConfigurableVirtualZoneItem

getAmetysObjectById

public ConfigurableVirtualZoneItem getAmetysObjectById(String id)
                                                throws AmetysRepositoryException

Description copied from interface: AmetysObjectFactory

Retrieves an AmetysObject, given its id.
Id are like <protocol>://<protocol-specific-part>.

Specified by:

getAmetysObjectById in interface AmetysObjectFactory<ConfigurableVirtualZoneItem>

Parameters:

id - the identifier.

Returns:

the corresponding AmetysObject.

Throws:

AmetysRepositoryException - if an error occurs.

hasAmetysObjectForId

public boolean hasAmetysObjectForId(String id)
                             throws AmetysRepositoryException

Description copied from interface: AmetysObjectFactory

Return true if the specified id correspond to an existing AmetysObject. Id are like <protocol>://<protocol-specific-part>.

Specified by:

hasAmetysObjectForId in interface AmetysObjectFactory<ConfigurableVirtualZoneItem>

Parameters:

id - the identifier.

Returns:

true if the specified id correspond to an existing AmetysObject.

Throws:

AmetysRepositoryException - if an error occurs.

getScheme

public String getScheme()

Description copied from interface: AmetysObjectFactory

Returns the protocol of this factory, used to construct unique ids.

Specified by:

getScheme in interface AmetysObjectFactory<ConfigurableVirtualZoneItem>

Returns:

the protocol of this factory.

getServiceExtensionPoint

public ServiceExtensionPoint getServiceExtensionPoint()

Get the service extension point

Returns:

The ServiceExtensionPoint

getZoneItemDataTypeExtensionPoint

public ModelItemTypeExtensionPoint getZoneItemDataTypeExtensionPoint()

Get the zone item data type extension point

Returns:

The ModelItemTypeExtensionPoint

getZoneFactory

public ConfigurableVirtualZoneFactory getZoneFactory()

Get the Configurable virtual zone's factory

Returns:

The ConfigurableVirtualZoneFactory

getI18nUtils

public I18nUtils getI18nUtils()

Get the i18n utils

Returns:

The I18nUtils