Package org.ametys.plugins.odfpilotage.report.impl

Class ApogeeReport

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

org.ametys.plugins.odfpilotage.report.AbstractPilotageReport

org.ametys.plugins.odfpilotage.report.impl.AbstractReport

org.ametys.plugins.odfpilotage.report.impl.ApogeeReport

All Implemented Interfaces:

PilotageReport, LogEnabled, PluginAware, Initializable, Configurable, Serviceable

public class ApogeeReport
extends AbstractReport

Pilotage report for Apogée.

Nested Class Summary

Nested classes/interfaces inherited from class org.ametys.plugins.odfpilotage.report.AbstractPilotageReport

AbstractPilotageReport.PilotageFile, AbstractPilotageReport.PilotageReportStatus

Nested classes/interfaces inherited from interface org.ametys.plugins.odfpilotage.report.PilotageReport

PilotageReport.PilotageReportTarget

Field Summary

Fields inherited from class org.ametys.plugins.odfpilotage.report.AbstractPilotageReport

_currentFormattedDate, _i18nUtils, _odfHelper, _pilotageHelper, _refTableHelper, _reportHelper, _resolver, _sourceResolver, _tmpFolder, _userManager, MANIFEST_FILENAME

Fields inherited from interface org.ametys.plugins.odfpilotage.report.PilotageReport

OUTPUT_FORMAT_CSV, OUTPUT_FORMAT_DOC, OUTPUT_FORMAT_XLS, PARAMETER_CATALOG, PARAMETER_LANG, PARAMETER_ORGUNIT, PARAMETER_OUTPUT_FORMAT, PARAMETER_PROGRAM

Constructor Summary

Constructors

Constructor	Description
ApogeeReport()

Method Summary

Modifier and Type	Method	Description
protected void	_launchByOrgUnit(String uaiCode, String catalog, String lang)	Launch a report generation on an orgunit.
protected void	_writeApogeeReport(String uaiCode, String catalog, String lang)	Create the Apogee report for one organization unit
protected Set<String>	getSupportedOutputFormats()	Get the list of supported output formats
protected String	getType()	Get the name of the report
protected void	saxAdditionalCourseData(TransformerHandler handler, Course course)	Generates SAX events for additional data of a Course.

Methods inherited from class org.ametys.plugins.odfpilotage.report.impl.AbstractReport

_getReportFileName, isSupportedTarget, launchByOrgUnit, launchByProgram

Methods inherited from class org.ametys.plugins.odfpilotage.report.AbstractPilotageReport

_buildZipName, addManifest, configure, convertReport, createZipFile, getId, getLabel, getMailBody, getMailSubject, getOutputFormat, getPipeline, getPluginName, getReportName, initialize, isCompatibleSchedulable, isGeneric, isSupportedFormat, launch, sendMail, service, setPluginInfo, supports

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

ApogeeReport

public ApogeeReport()

Method Details

_launchByOrgUnit

protected void _launchByOrgUnit(String uaiCode,
 String catalog,
 String lang)
                         throws Exception

Description copied from class: AbstractReport

Launch a report generation on an orgunit.

Specified by:

_launchByOrgUnit in class AbstractReport

Parameters:

uaiCode - The UAI code of the OrgUnit

catalog - The catalog

lang - The language

Throws:

Exception - if an exception occurs

getType

protected String getType()

Description copied from class: AbstractPilotageReport

Get the name of the report

Specified by:

getType in class AbstractPilotageReport

Returns:

The report name

getSupportedOutputFormats

protected Set<String> getSupportedOutputFormats()

Description copied from class: AbstractPilotageReport

Get the list of supported output formats

Overrides:

getSupportedOutputFormats in class AbstractPilotageReport

Returns:

A Set of supported output formats

_writeApogeeReport

protected void _writeApogeeReport(String uaiCode,
 String catalog,
 String lang)

Create the Apogee report for one organization unit

Parameters:

uaiCode - The UAI code of the org unit

catalog - The catalog

lang - The language

saxAdditionalCourseData

protected void saxAdditionalCourseData(TransformerHandler handler,
 Course course)
                                throws AmetysRepositoryException,
SAXException

Generates SAX events for additional data of a Course.

Parameters:

handler - The handler

course - The course to SAX

Throws:

AmetysRepositoryException - if an error occurs

SAXException - if an error occurs