Package org.ametys.plugins.odfpilotage.report

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

Nested Classes

Modifier and Type	Interface	Description
static enum	PilotageReport.PilotageReportTarget	The pilotage report target.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	OUTPUT_FORMAT_CSV	The CSV output format
static final String	OUTPUT_FORMAT_DOC	The DOC output format
static final String	OUTPUT_FORMAT_XLS	The XLS output format
static final String	PARAMETER_CATALOG	The key for the catalog
static final String	PARAMETER_LANG	The key for the lang
static final String	PARAMETER_ORGUNIT	The key for the orgunit
static final String	PARAMETER_OUTPUT_FORMAT	The key for the output format
static final String	PARAMETER_PROGRAM	The key for the program

Method Summary

Modifier and Type	Method	Description
String	getId()	Retrieves the id of the report.
I18nizableText	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

static final String PARAMETER_OUTPUT_FORMAT

The key for the output format

See Also:

• Constant Field Values

PARAMETER_PROGRAM

static final String PARAMETER_PROGRAM

The key for the program

See Also:

• Constant Field Values

PARAMETER_ORGUNIT

static final String PARAMETER_ORGUNIT

The key for the orgunit

See Also:

• Constant Field Values

PARAMETER_CATALOG

static final String PARAMETER_CATALOG

The key for the catalog

See Also:

• Constant Field Values

PARAMETER_LANG

static final String PARAMETER_LANG

The key for the lang

See Also:

• Constant Field Values

OUTPUT_FORMAT_XLS

static final String OUTPUT_FORMAT_XLS

The XLS output format

See Also:

• Constant Field Values

OUTPUT_FORMAT_DOC

static final String OUTPUT_FORMAT_DOC

The DOC output format

See Also:

• Constant Field Values

OUTPUT_FORMAT_CSV

static final String OUTPUT_FORMAT_CSV

The CSV output format

See Also:

• Constant Field Values

Method Details

getId

String getId()

Retrieves the id of the report.

Returns:

the id.

getLabel

I18nizableText getLabel()

Retrieves the label of the report.

Returns:

the label.

supports

boolean supports(AbstractReportSchedulable schedulable)

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 report

reportParameters - The report parameters

user - The current user