Package org.ametys.plugins.odfweb.inputdata

Class CourseInputData

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

org.ametys.plugins.odfweb.inputdata.CourseInputData

All Implemented Interfaces:

LogEnabled, InputData, Initializable, Contextualizable, Serviceable

public class CourseInputData
extends AbstractLogEnabled
implements InputData, Contextualizable, Initializable, Serviceable

InputData for SAXing the list of programs having the current course among their courseLists

Field Summary

Fields

Modifier and Type	Field	Description
protected AmetysObjectResolver	_ametysResolver	The ametys object resolver.
protected Context	_context	Avalon context.
private boolean	_isActive	Configuration boolean to active or not the inputdata
protected OdfPageHandler	_odfPageHandler	The root handler
protected OdfReferenceTableHelper	_odfRefTableHelper	The ODF reference table helper
protected SiteManager	_siteManager	CMS Sites manager

Constructor Summary

Constructors

Constructor	Description
CourseInputData()

Method Summary

Modifier and Type	Method	Description
void	contextualize(Context context)
void	initialize()
boolean	isCacheable(Site site, Page page)	Returns true if this InputData is cacheable for the current site and if possible page.
void	saxProgram(Program program, ContentHandler contentHandler)	SAX a program.
void	service(ServiceManager manager)
void	toSAX(ContentHandler handler)	Generates SAX events for providing data.

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

Methods inherited from interface org.ametys.web.inputdata.InputData

shouldBeCached

Field Detail

_context

protected Context _context

Avalon context.

_ametysResolver

protected AmetysObjectResolver _ametysResolver

The ametys object resolver.

_siteManager

protected SiteManager _siteManager

CMS Sites manager

_odfPageHandler

protected OdfPageHandler _odfPageHandler

The root handler

_odfRefTableHelper

protected OdfReferenceTableHelper _odfRefTableHelper

The ODF reference table helper

_isActive

private boolean _isActive

Configuration boolean to active or not the inputdata

Constructor Detail

CourseInputData

public CourseInputData()

Method Detail

service

public void service(ServiceManager manager)
             throws ServiceException

Specified by:

service in interface Serviceable

Throws:

ServiceException

contextualize

public void contextualize(Context context)
                   throws ContextException

Specified by:

contextualize in interface Contextualizable

Throws:

ContextException

initialize

public void initialize()
                throws Exception

Specified by:

initialize in interface Initializable

Throws:

Exception

isCacheable

public boolean isCacheable(Site site,
                           Page page)

Description copied from interface: InputData

Returns true if this InputData is cacheable for the current site and if possible page.

Specified by:

isCacheable in interface InputData

Parameters:

site - the current Site.

page - the current Page. Can be null.

Returns:

true if this InputData is cacheable for the current site or page.

toSAX

public void toSAX(ContentHandler handler)
           throws SAXException,
                  ProcessingException

Description copied from interface: InputData

Generates SAX events for providing data.

Specified by:

toSAX in interface InputData

Parameters:

handler - the content handler to SAX into.

Throws:

SAXException - if an error occurs while SAXing.

ProcessingException - if an error occurs during processing.

saxProgram

public void saxProgram(Program program,
                       ContentHandler contentHandler)
                throws SAXException,
                       IOException

SAX a program.

Parameters:

program - The program to SAX.

contentHandler - the content handler

Throws:

SAXException - If an error occurs while SAXing

IOException - If an error occurs while retrieving content.