org.cyclos.services.system

Interface ReportService

All Superinterfaces:

Service

public interface ReportService
extends Service

Method Summary

Modifier and Type	Method and Description
SystemReportData	getSystemReportData() Gets the data for system reports.
SerializableInputStream	readSystemReport(@NotNull SystemReportQuery query) Generates a PDF content for a system report, showing reports on the complete system.
SerializableInputStream	readUserReport(@NotNull UserReportQuery query) Generates a PDF content for a user report
void	validate(@NotNull SystemReportQuery query) Validates the system reports. this must be called before calling readSystemReport(SystemReportQuery).

Method Detail

getSystemReportData

SystemReportData getSystemReportData()
                              throws FrameworkException

Gets the data for system reports.

Throws:

FrameworkException

readSystemReport

SerializableInputStream readSystemReport(@NotNull
                                         @NotNull SystemReportQuery query)
                                  throws FrameworkException,
                                         ReportExecutionException

Generates a PDF content for a system report, showing reports on the complete system. Note that if the query has no groups selected, the method assumes that all visible groups are to be selected.

Throws:

FrameworkException

ReportExecutionException

readUserReport

SerializableInputStream readUserReport(@NotNull
                                       @NotNull UserReportQuery query)
                                throws FrameworkException,
                                       ReportExecutionException

Generates a PDF content for a user report

Throws:

FrameworkException

ReportExecutionException

validate

void validate(@NotNull
              @NotNull SystemReportQuery query)
       throws ValidationException,
              FrameworkException

Validates the system reports. this must be called before calling readSystemReport(SystemReportQuery).

Throws:

ValidationException

FrameworkException