org.netxms.api.client.reporting

Interface ReportingServerManager

public interface ReportingServerManager

Reporting server management interface

Method Summary

Methods

Modifier and Type	Method and Description
void	deleteReportResult(UUID reportId, UUID jobId)
void	deleteReportSchedule(UUID reportId, UUID jobId)
UUID	executeReport(UUID reportId, Map<String,String> parameters)
ReportDefinition	getReportDefinition(UUID reportId)
List<ReportResult>	listReportResults(UUID reportId)
List<UUID>	listReports()
List<ReportingJob>	listScheduledJobs(UUID reportId)
File	renderReport(UUID reportId, UUID jobId, ReportRenderFormat format)
void	scheduleReport(ReportingJob reportingJob, Map<String,String> parameters)

Method Detail

listReports

List<UUID> listReports()
                       throws NetXMSClientException,
                              IOException

Throws:

NetXMSClientException

IOException

getReportDefinition

ReportDefinition getReportDefinition(UUID reportId)
                                     throws NetXMSClientException,
                                            IOException

Throws:

NetXMSClientException

IOException

executeReport

UUID executeReport(UUID reportId,
                 Map<String,String> parameters)
                   throws NetXMSClientException,
                          IOException

Throws:

NetXMSClientException

IOException

scheduleReport

void scheduleReport(ReportingJob reportingJob,
                  Map<String,String> parameters)
                    throws NetXMSClientException,
                           IOException

Throws:

NetXMSClientException

IOException

listScheduledJobs

List<ReportingJob> listScheduledJobs(UUID reportId)
                                     throws NetXMSClientException,
                                            IOException

Throws:

NetXMSClientException

IOException

listReportResults

List<ReportResult> listReportResults(UUID reportId)
                                     throws NetXMSClientException,
                                            IOException

Throws:

NetXMSClientException

IOException

deleteReportResult

void deleteReportResult(UUID reportId,
                      UUID jobId)
                        throws NetXMSClientException,
                               IOException

Throws:

NetXMSClientException

IOException

deleteReportSchedule

void deleteReportSchedule(UUID reportId,
                        UUID jobId)
                          throws NetXMSClientException,
                                 IOException

Throws:

NetXMSClientException

IOException

renderReport

File renderReport(UUID reportId,
                UUID jobId,
                ReportRenderFormat format)
                  throws NetXMSClientException,
                         IOException

Throws:

NetXMSClientException

IOException