public interface ScheduledReportManager
Modifier and Type | Method and Description |
---|---|
ScheduledReport |
createScheduledReport(javax.xml.registry.infomodel.RegistryObject registryObject)
Create a Scheduled Report based on a RegistryObject.
|
ScheduledReport |
createScheduledReport(java.lang.String recipientId,
java.lang.String reportId)
Create a Scheduled Report which is daily executed.
|
ScheduledReport |
createScheduledReport(java.lang.String recipientId,
java.lang.String reportId,
java.lang.String occurrenceId)
Create a Scheduled Report which executed in the given occurrence.
|
ScheduledReport |
createScheduledReport(java.lang.String recipientId,
java.lang.String reportId,
java.lang.String occurrenceId,
java.lang.String name,
java.lang.String description)
Create a Scheduled Report which executed in the given occurrence.
|
ScheduledReport |
createScheduledReport(java.lang.String recipientId,
java.lang.String reportId,
java.lang.String occurrenceId,
java.lang.String name,
java.lang.String description,
java.util.Locale locale)
Create a Scheduled Report.
|
java.util.Collection<ScheduledReport> |
createScheduledReports(java.util.Collection<javax.xml.registry.infomodel.RegistryObject> registryObjects)
Create a collection of Scheduled Reports based on a collection of RegistryObject.
|
void |
generateAndSendReport(ScheduledReport scheduledReport)
Generates and sends a BIRT report.
|
java.io.OutputStream |
generateReport(java.io.OutputStream outputStream,
ScheduledReport scheduledReport)
Generates a report based on a report template, which is associated to the given Scheduled Report.
|
java.io.OutputStream |
generateReport(java.io.OutputStream outputStream,
java.lang.String scheduledReportId)
Generates a report based on a report template, which is associated to the given Scheduled Report.
|
java.io.OutputStream |
generateReportAsExcel(java.io.OutputStream outputStream,
java.lang.String recipientId,
java.lang.String reportId,
java.util.Locale locale,
java.util.Collection<ReportParameter> parameters)
Generates a report based on the given report template as EXCEL document.
|
java.io.OutputStream |
generateReportAsHtml(java.io.OutputStream outputStream,
java.lang.String recipientId,
java.lang.String reportId,
java.util.Locale locale,
java.util.Collection<ReportParameter> parameters)
Generates a report based on the given report template as HTML document.
|
java.io.OutputStream |
generateReportAsPdf(java.io.OutputStream outputStream,
java.lang.String recipientId,
java.lang.String reportId,
java.util.Locale locale,
java.util.Collection<ReportParameter> parameters)
Generates a report based on the given report template as PDF document.
|
java.io.OutputStream |
generateReportAsWord(java.io.OutputStream outputStream,
java.lang.String recipientId,
java.lang.String reportId,
java.util.Locale locale,
java.util.Collection<ReportParameter> parameters)
Generates a report based on the given report template as WORD document.
|
java.io.OutputStream |
getReportDataAsCsv(java.io.OutputStream outputStream,
java.lang.String recipientId,
java.lang.String reportId,
java.util.Locale locale,
java.util.Collection<ReportParameter> parameters)
Get the data of a report based on the given report template as comma separated values.
|
java.util.Collection<ReportParameter> |
getReportParameters(java.lang.String scheduledReportId,
java.util.Locale locale)
Get a list of parameters for the given Scheduled Report.
|
ScheduledReport |
getScheduledReport(java.lang.String scheduledReportId)
Get Scheduled Report specified by id.
|
java.util.Collection<ScheduledReport> |
getScheduledReports()
Get a list of all Scheduled Reports.
|
java.util.Collection<ScheduledReport> |
getScheduledReports(java.lang.String recipientId)
Get Scheduled Reports for a given recipient.
|
ScheduledReport createScheduledReport(java.lang.String recipientId, java.lang.String reportId) throws javax.xml.registry.JAXRException
recipientId
- Id. of the recipient to whom the report will be sent.reportId
- Id. of the report (template) to be triggered.javax.xml.registry.JAXRException
ScheduledReport createScheduledReport(java.lang.String recipientId, java.lang.String reportId, java.lang.String occurrenceId) throws javax.xml.registry.JAXRException
recipientId
- Id. of the recipient to whom the report will be sent.reportId
- Id. of the report (template) to be triggered.occurrenceId
- Id. indicating how often the report is scheduled. The id. must have one of the following predefined values:
javax.xml.registry.JAXRException
ScheduledReport createScheduledReport(java.lang.String recipientId, java.lang.String reportId, java.lang.String occurrenceId, java.lang.String name, java.lang.String description) throws javax.xml.registry.JAXRException
recipientId
- Id. of the recipient to whom the report will be sent.reportId
- Id. of the report (template) to be triggered.occurrenceId
- Id. indicating how often the report is scheduled. The id. must have one of the following predefined values:
name
- Name of the scheduled report.description
- Describes the scheduled report.javax.xml.registry.JAXRException
ScheduledReport createScheduledReport(java.lang.String recipientId, java.lang.String reportId, java.lang.String occurrenceId, java.lang.String name, java.lang.String description, java.util.Locale locale) throws javax.xml.registry.JAXRException
recipientId
- Id. of the recipient to whom the report will be sent.reportId
- Id. of the report (template) to be triggered.occurrenceId
- Id. indicating how often the report is scheduled. The id. must have one of the following predefined values:
name
- Name of the scheduled report.description
- Describes the scheduled report.locale
- The locale for name and description.javax.xml.registry.JAXRException
ScheduledReport createScheduledReport(javax.xml.registry.infomodel.RegistryObject registryObject) throws java.lang.Exception
registryObject
- A RegistryObject of type "OBJECT_TYPE_KEY_ScheduledReport".java.lang.Exception
java.util.Collection<ScheduledReport> createScheduledReports(java.util.Collection<javax.xml.registry.infomodel.RegistryObject> registryObjects) throws java.lang.Exception
registryObjects
- A collection of RegistryObjects of type "OBJECT_TYPE_KEY_ScheduledReport".java.lang.Exception
java.util.Collection<ScheduledReport> getScheduledReports() throws java.lang.Exception
java.lang.Exception
java.util.Collection<ScheduledReport> getScheduledReports(java.lang.String recipientId) throws java.lang.Exception
recipientId
- Id. of the recipient to whom the reports will be sent.java.lang.Exception
ScheduledReport getScheduledReport(java.lang.String scheduledReportId) throws java.lang.Exception
scheduledReportId
- The id. of Scheduled Reportjava.lang.Exception
java.util.Collection<ReportParameter> getReportParameters(java.lang.String scheduledReportId, java.util.Locale locale) throws java.lang.Exception
scheduledReportId
- The id. of Scheduled Reportlocale
- The locale of the parameter prompt text.java.lang.Exception
void generateAndSendReport(ScheduledReport scheduledReport) throws java.lang.Exception
scheduledReport
- The scheduled report object to generate the BIRT report for.java.lang.Exception
java.io.OutputStream generateReport(java.io.OutputStream outputStream, java.lang.String scheduledReportId) throws java.lang.Exception
outputStream
- The outputStream of the generated BIRT report.scheduledReportId
- The id. of Scheduled Reportjava.lang.Exception
java.io.OutputStream generateReport(java.io.OutputStream outputStream, ScheduledReport scheduledReport) throws java.lang.Exception
outputStream
- The outputStream of the generated BIRT report.scheduledReport
- The scheduled report object to generate the BIRT report for.java.lang.Exception
java.io.OutputStream generateReportAsPdf(java.io.OutputStream outputStream, java.lang.String recipientId, java.lang.String reportId, java.util.Locale locale, java.util.Collection<ReportParameter> parameters) throws java.lang.Exception
outputStream
- The outputStream of the generated BIRT report.recipientId
- Id. of the recipient to whom the report will be sent.reportId
- Id. of the report (template) to be triggered.locale
- The locale to generate the BIRT report for.parameters
- The list of parameters of the scheduled report.java.lang.Exception
java.io.OutputStream generateReportAsHtml(java.io.OutputStream outputStream, java.lang.String recipientId, java.lang.String reportId, java.util.Locale locale, java.util.Collection<ReportParameter> parameters) throws java.lang.Exception
outputStream
- The outputStream of the generated BIRT report.recipientId
- Id. of the recipient to whom the report will be sent.reportId
- Id. of the report (template) to be triggered.locale
- The locale to generate the BIRT report for.parameters
- The list of parameters of the scheduled report.java.lang.Exception
java.io.OutputStream generateReportAsWord(java.io.OutputStream outputStream, java.lang.String recipientId, java.lang.String reportId, java.util.Locale locale, java.util.Collection<ReportParameter> parameters) throws java.lang.Exception
outputStream
- The outputStream of the generated BIRT report.recipientId
- Id. of the recipient to whom the report will be sent.reportId
- Id. of the report (template) to be triggered.locale
- The locale to generate the BIRT report for.parameters
- The list of parameters of the scheduled report.java.lang.Exception
java.io.OutputStream generateReportAsExcel(java.io.OutputStream outputStream, java.lang.String recipientId, java.lang.String reportId, java.util.Locale locale, java.util.Collection<ReportParameter> parameters) throws java.lang.Exception
outputStream
- The outputStream of the generated BIRT report.recipientId
- Id. of the recipient to whom the report will be sent.reportId
- Id. of the report (template) to be triggered.locale
- The locale to generate the BIRT report for.parameters
- The list of parameters of the scheduled report.java.lang.Exception
java.io.OutputStream getReportDataAsCsv(java.io.OutputStream outputStream, java.lang.String recipientId, java.lang.String reportId, java.util.Locale locale, java.util.Collection<ReportParameter> parameters) throws java.lang.Exception
outputStream
- The OutputStream of the generated comma separated values.reportTemplate
- The InputStream of the report (template) to be triggered.parameters
- The list of parameters of the scheduled report.java.lang.Exception