Package org.ametys.plugins.userdirectory.page

Class TransitionalPageFactory

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

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

org.ametys.plugins.userdirectory.page.AbstractUserDirectoryPageFactory

org.ametys.plugins.userdirectory.page.TransitionalPageFactory

All Implemented Interfaces:

AmetysObjectFactory<TransitionalPage>, LogEnabled, Component, Configurable, Contextualizable, Serviceable

public class TransitionalPageFactory
extends AbstractUserDirectoryPageFactory
implements AmetysObjectFactory<TransitionalPage>

AmetysObjectFactory handling TransitionalPage.

Field Summary

Fields inherited from class org.ametys.plugins.userdirectory.page.AbstractUserDirectoryPageFactory

_synchronizableContentsCollectionDAO, _userDirectoryPageHandler

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

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

Constructor Summary

Constructors

Constructor	Description
TransitionalPageFactory()

Method Summary

Modifier and Type	Method	Description
TransitionalPage	createTransitionalPage(Page root, String prefix, String path)	Create a transitional page.
TransitionalPage	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.userdirectory.page.AbstractUserDirectoryPageFactory

getOrgUnitPageFactory, getSynchronizableContentsCollectionDAO, getTransitionalPageFactory, getUserDirectoryPageHandler, getUserPageFactory, service

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

configure, contextualize, getAmetysObjectFactoryEP, getConfiguration, getI18nUtils, getPageDataTypeEP, getRequest, 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

TransitionalPageFactory

public TransitionalPageFactory()

Method Details

createTransitionalPage

public TransitionalPage createTransitionalPage(Page root,
 String prefix,
 String path)

Create a transitional page.

Parameters:

root - the user directory root page.

prefix - the page's title.

path - the path

Returns:

The TransitionalPage created

getAmetysObjectById

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

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

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

Returns:

the protocol of this factory.