Interface PilotageReport
- All Known Implementing Classes:
AbstractExtract
,AbstractMCCReport
,AbstractPilotageReport
,AbstractReport
,ApogeeReport
,ConsistencyExtract
,CoutMaquettesReport
,MaquetteExtract
,MCCDiffReport
,MCCReport
,PotentielEnseignantReport
,ReglementEtudesExtract
,SyntheseReport
,VolumeHoraireReport
public interface PilotageReport
Interface for pilotage reports.
-
Nested Class Summary
Modifier and TypeInterfaceDescriptionstatic enum
The pilotage report target. -
Field Summary
Modifier and TypeFieldDescriptionstatic final String
The CSV output formatstatic final String
The DOC output formatstatic final String
The XLS output formatstatic final String
The key for the catalogstatic final String
The key for the langstatic final String
The key for the orgunitstatic final String
The key for the output formatstatic final String
The key for the program -
Method Summary
Modifier and TypeMethodDescriptiongetId()
Retrieves the id of the report.getLabel()
Retrieves the label of the report.void
launch
(PilotageReport.PilotageReportTarget target, Map<String, String> reportParameters, UserIdentity user) Launch a report on the given target with the given parameters.boolean
supports
(AbstractReportSchedulable schedulable) Check if the report supports the given schedulable.
-
Field Details
-
PARAMETER_OUTPUT_FORMAT
The key for the output format- See Also:
-
PARAMETER_PROGRAM
The key for the program- See Also:
-
PARAMETER_ORGUNIT
The key for the orgunit- See Also:
-
PARAMETER_CATALOG
The key for the catalog- See Also:
-
PARAMETER_LANG
The key for the lang- See Also:
-
OUTPUT_FORMAT_XLS
The XLS output format- See Also:
-
OUTPUT_FORMAT_DOC
The DOC output format- See Also:
-
OUTPUT_FORMAT_CSV
The CSV output format- See Also:
-
-
Method Details
-
getId
Retrieves the id of the report.- Returns:
- the id.
-
getLabel
Retrieves the label of the report.- Returns:
- the label.
-
supports
Check if the report supports the given schedulable.- Parameters:
schedulable
- The schedulable to check- Returns:
true
if the schedulable is supported,false
otherwise
-
launch
void launch(PilotageReport.PilotageReportTarget target, Map<String, String> reportParameters, UserIdentity user) Launch a report on the given target with the given parameters.- Parameters:
target
- The target of the reportreportParameters
- The report parametersuser
- The current user
-