Package org.ametys.plugins.userdirectory.page

Class UserPageFactory

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

All Implemented Interfaces:

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

public class UserPageFactory
extends AbstractUserDirectoryPageFactory
implements AmetysObjectFactory<UserPage>

AmetysObjectFactory handling UserPage.

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
UserPageFactory()

Method Summary

Modifier and Type	Method	Description
UserPage	createUserPage(Page root, Content syncContent, String path)	Create a User page.
UserPage	getAmetysObjectById(String id)	Retrieves an AmetysObject, given its id. Id are like <protocol>://<protocol-specific-part>.
SynchronizableContentsCollectionHelper	getSccHelper()	Get the synchronizable contents collection helper
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.
void	service(ServiceManager manager)

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

getOrgUnitPageFactory, getSynchronizableContentsCollectionDAO, getTransitionalPageFactory, getUserDirectoryPageHandler, getUserPageFactory

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

UserPageFactory

public UserPageFactory()

Method Details

service

public void service(ServiceManager manager)
             throws ServiceException

Specified by:

service in interface Serviceable

Overrides:

service in class AbstractUserDirectoryPageFactory

Throws:

ServiceException

createUserPage

public UserPage createUserPage(Page root,
 Content syncContent,
 String path)

Create a User page.

Parameters:

root - the root page.

syncContent - the synchronized content

path - the path

Returns:

The UserPager created

getAmetysObjectById

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

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

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

Returns:

the protocol of this factory.

getSccHelper

public SynchronizableContentsCollectionHelper getSccHelper()

Get the synchronizable contents collection helper

Returns:

The SynchronizableContentsCollectionHelper