Class AbstractReport
java.lang.Object
org.ametys.runtime.plugin.component.AbstractLogEnabled
org.ametys.plugins.odfpilotage.report.AbstractPilotageReport
org.ametys.plugins.odfpilotage.report.impl.AbstractReport
- All Implemented Interfaces:
PilotageReport
,LogEnabled
,PluginAware
,Initializable
,Configurable
,Serviceable
- Direct Known Subclasses:
AbstractMCCReport
,ApogeeReport
,CoutMaquettesReport
,PotentielEnseignantReport
,SyntheseReport
,VolumeHoraireReport
The abstract class for pilotage reports.
-
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
-
Method Summary
Modifier and TypeMethodDescriptionprotected String
_getReportFileName
(String catalog, String lang, String accronymOrUaiCode) Get the report filename for a given orgunitprotected abstract void
_launchByOrgUnit
(String uaiCode, String catalog, String lang) Launch a report generation on an orgunit.protected boolean
Returnstrue
if the target is supported by the report.protected String
launchByOrgUnit
(Map<String, String> reportParameters) Launch a report generation on an orgunit.protected String
launchByProgram
(Map<String, String> reportParameters) Launch a report generation on a program.Methods inherited from class org.ametys.plugins.odfpilotage.report.AbstractPilotageReport
_buildZipName, addManifest, configure, convertReport, createZipFile, getId, getLabel, getMailBody, getMailSubject, getOutputFormat, getPipeline, getPluginName, getReportName, getSupportedOutputFormats, getType, initialize, isCompatibleSchedulable, isGeneric, isSupportedFormat, launch, sendMail, service, setPluginInfo, supports
Methods inherited from class org.ametys.runtime.plugin.component.AbstractLogEnabled
getLogger, setLogger
-
Constructor Details
-
AbstractReport
public AbstractReport()
-
-
Method Details
-
isSupportedTarget
Description copied from class:AbstractPilotageReport
Returnstrue
if the target is supported by the report.- Specified by:
isSupportedTarget
in classAbstractPilotageReport
- Parameters:
target
- The target to test- Returns:
true
if the target is supported,false
otherwise
-
launchByProgram
Description copied from class:AbstractPilotageReport
Launch a report generation on a program.- Specified by:
launchByProgram
in classAbstractPilotageReport
- Parameters:
reportParameters
- The report parameters- Returns:
- the name of the generated file
- Throws:
Exception
- if an exception occurs
-
launchByOrgUnit
Description copied from class:AbstractPilotageReport
Launch a report generation on an orgunit.- Specified by:
launchByOrgUnit
in classAbstractPilotageReport
- Parameters:
reportParameters
- The report parameters- Returns:
- the name of the generated file
- Throws:
Exception
- if an exception occurs
-
_launchByOrgUnit
protected abstract void _launchByOrgUnit(String uaiCode, String catalog, String lang) throws Exception Launch a report generation on an orgunit. -
_getReportFileName
Get the report filename for a given orgunit- Parameters:
catalog
- The cataloglang
- The langaccronymOrUaiCode
- The UAI code- Returns:
- the file name
-