Package org.ametys.plugins.odfweb.repository

Class ProgramPageFactory

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

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

org.ametys.plugins.odfweb.repository.AbstractOdfPageFactory

org.ametys.plugins.odfweb.repository.ProgramPageFactory

All Implemented Interfaces:

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

public class ProgramPageFactory
extends AbstractOdfPageFactory
implements AmetysObjectFactory<ProgramPage>

AmetysObjectFactory handling ProgramPage.

Field Summary

Fields inherited from class org.ametys.plugins.odfweb.repository.AbstractOdfPageFactory

_odfHelper, _odfPageHandler, _pageCache

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

Method Summary

Modifier and Type	Method	Description
ProgramPage	createProgramPage(Page root, AbstractProgram program, String path, Program parent, Page parentPage)	Create a program page.
ProgramPage	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.odfweb.repository.AbstractOdfPageFactory

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

ProgramPageFactory

public ProgramPageFactory()

Method Details

createProgramPage

public ProgramPage createProgramPage(Page root,
 AbstractProgram program,
 String path,
 Program parent,
 Page parentPage)

Create a program page.

Parameters:

root - the ODF root page.

program - the program or subprogram.

path - The path from the virtual second level page. Can be null if abstract program is a Program

parent - the parent program in case of a subprogram, null otherwise

parentPage - the parent Page or null if not yet computed.

Returns:

The ProgramPage created

getAmetysObjectById

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

Parameters:

id - the identifier.

Returns:

the corresponding 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<ProgramPage>

Returns:

the protocol of this factory.

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

Parameters:

id - the identifier.

Returns:

true if the specified id correspond to an existing AmetysObject.

Throws:

AmetysRepositoryException - if an error occurs.