Package org.ametys.plugins.ugc.page

Class UGCPageFactory

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

org.ametys.web.repository.page.virtual.AbstractConfigurableVirtualPageFactory

org.ametys.plugins.ugc.page.AbstractUGCPageFactory

org.ametys.plugins.ugc.page.UGCPageFactory

All Implemented Interfaces:

AmetysObjectFactory<UGCPage>, LogEnabled, Component, Configurable, Serviceable

public class UGCPageFactory
extends AbstractUGCPageFactory
implements AmetysObjectFactory<UGCPage>

AmetysObjectFactory handling UGCPage.

Field Summary

Fields inherited from class org.ametys.plugins.ugc.page.AbstractUGCPageFactory

_skinManager, _ugcPageHandler

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

_ametysObjectFactoryEP, _configurationId, _i18nUtils, _manager, _pageDataTypeExtensionPoint, _resolver, _saxParser, _serviceExtensionPoint, _skinsManager, _virtualPageConfigurationEP, _zoneFactoryId

Constructor Summary

Constructors

Constructor	Description
UGCPageFactory()

Method Summary

Modifier and Type	Method	Description
UGCPage	createUGCPage(Page root, Content syncContent, String path)	Create a UGC page.
UGCPage	getAmetysObjectById(String id)	Retrieves an AmetysObject, given its id. Id are like <protocol>://<protocol-specific-part>.
String	getScheme()	Returns the protocol of this factory, used to construct unique ids.
boolean	hasAmetysObjectForId(String id)	Return true if the specified id correspond to an existing AmetysObject.

Methods inherited from class org.ametys.plugins.ugc.page.AbstractUGCPageFactory

getConfiguration, getUgcPageHandler, service

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

configure, getAmetysObjectFactoryEP, getConfiguration, getI18nUtils, getPageDataTypeEP, getResolver, getSaxParser, getServiceEP, getSkinsManager, getZoneFactory

Methods inherited from class org.ametys.runtime.plugin.component.AbstractLogEnabled

getLogger, setLogger

Methods inherited from class java.lang.Object

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

Constructor Details

UGCPageFactory

public UGCPageFactory()

Method Details

createUGCPage

public UGCPage createUGCPage(Page root,
 Content syncContent,
 String path)

Create a UGC page.

Parameters:

root - the root page.

syncContent - the synchronized content

path - the path

Returns:

The UGCPage created

getAmetysObjectById

public UGCPage 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<UGCPage>

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

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

Returns:

the protocol of this factory.