Package net.datenwerke.rs.core.service.reportmanager.hooks

Interface ReportExecutionNotificationHook

All Superinterfaces:

Hook

All Known Implementing Classes:

LargeReportExecutionVetoer, OutputFormatAuthWatchDog, ReportExecutionNotificationHookAdapter

@HookConfig
public interface ReportExecutionNotificationHook
extends Hook

Hook used by the ReportEngine. It allows to be notified of report execution events, and can be used to stop the execution of a report.

Method Summary

Modifier and Type	Method	Description
void	doVetoReportExecution(Report report, ParameterSet parameterSet, User user, String outputFormat, ReportExecutionConfig[] configs)	Called before the execution of a report and meant to allow to veto (stop) that execution.
void	notifyOfReportExecution(Report report, ParameterSet parameterSet, User user, String outputFormat, ReportExecutionConfig[] configs)	Called before a report is about to be executed.
void	notifyOfReportsSuccessfulExecution(CompiledReport compiledReport, Report report, ParameterSet parameterSet, User user, String outputFormat, ReportExecutionConfig[] configs)	Called after successful completion of a report execution.
void	notifyOfReportsUnsuccessfulExecution(ReportExecutorException e, Report report, ParameterSet parameterSet, User user, String outputFormat, ReportExecutionConfig[] configs)	Called after an unsuccessful execution of a report.

Method Details

notifyOfReportExecution

void notifyOfReportExecution(Report report,
 ParameterSet parameterSet,
 User user,
 String outputFormat,
 ReportExecutionConfig[] configs)
                      throws ReportExecutorException

Called before a report is about to be executed. This method should not throw any exceptions and be used only for notifaction purposes. If you want to stop the execution of a report, use the doVetoReportExecution(Report, ParameterSet, User, String, ReportExecutionConfig[]) method instead.

Parameters:

report -

parameterSet -

user -

outputFormat -

configs -

Throws:

ReportExecutorException

notifyOfReportsSuccessfulExecution

void notifyOfReportsSuccessfulExecution(CompiledReport compiledReport,
 Report report,
 ParameterSet parameterSet,
 User user,
 String outputFormat,
 ReportExecutionConfig[] configs)

Called after successful completion of a report execution.

Parameters:

compiledReport -

report -

parameterSet -

user -

outputFormat -

configs -

notifyOfReportsUnsuccessfulExecution

void notifyOfReportsUnsuccessfulExecution(ReportExecutorException e,
 Report report,
 ParameterSet parameterSet,
 User user,
 String outputFormat,
 ReportExecutionConfig[] configs)

Called after an unsuccessful execution of a report.

Parameters:

e -

report -

parameterSet -

user -

outputFormat -

configs -

doVetoReportExecution

void doVetoReportExecution(Report report,
 ParameterSet parameterSet,
 User user,
 String outputFormat,
 ReportExecutionConfig[] configs)
                    throws ReportExecutorException

Called before the execution of a report and meant to allow to veto (stop) that execution. In order to stop an execution, throw a ReportExecutorException.

Parameters:

report -

parameterSet -

user -

outputFormat -

configs -

Throws:

ReportExecutorException