org.netxms.api.client.reporting

Interface ReportingServerManager

public interface ReportingServerManager

Method Summary

Methods

Modifier and Type	Method and Description
void	deleteReportResult(java.util.UUID reportId, java.util.UUID jobId)
java.util.UUID	executeReport(java.util.UUID reportId, java.util.Map<java.lang.String,java.lang.String> parameters)
ReportDefinition	getReportDefinition(java.util.UUID reportId)
java.util.List<ReportResult>	listReportResults(java.util.UUID reportId)
java.util.List<java.util.UUID>	listReports()
java.util.List<ReportingJob>	listScheduledJobs()
java.io.File	renderReport(java.util.UUID reportId, java.util.UUID jobId, ReportRenderFormat format)
void	scheduleReport(java.util.UUID reportId, java.util.Date startTime, int daysOfWeek, int daysOfMonth, java.util.Map<java.lang.String,java.lang.String> parameters)

Method Detail

listReports

java.util.List<java.util.UUID> listReports()
                                           throws NetXMSClientException,
                                                  java.io.IOException

Throws:

NetXMSClientException

java.io.IOException

getReportDefinition

ReportDefinition getReportDefinition(java.util.UUID reportId)
                                     throws NetXMSClientException,
                                            java.io.IOException

Throws:

NetXMSClientException

java.io.IOException

executeReport

java.util.UUID executeReport(java.util.UUID reportId,
                           java.util.Map<java.lang.String,java.lang.String> parameters)
                             throws NetXMSClientException,
                                    java.io.IOException

Throws:

NetXMSClientException

java.io.IOException

scheduleReport

void scheduleReport(java.util.UUID reportId,
                  java.util.Date startTime,
                  int daysOfWeek,
                  int daysOfMonth,
                  java.util.Map<java.lang.String,java.lang.String> parameters)
                    throws NetXMSClientException,
                           java.io.IOException

Throws:

NetXMSClientException

java.io.IOException

listScheduledJobs

java.util.List<ReportingJob> listScheduledJobs()

listReportResults

java.util.List<ReportResult> listReportResults(java.util.UUID reportId)
                                               throws NetXMSClientException,
                                                      java.io.IOException

Throws:

NetXMSClientException

java.io.IOException

deleteReportResult

void deleteReportResult(java.util.UUID reportId,
                      java.util.UUID jobId)
                        throws NetXMSClientException,
                               java.io.IOException

Throws:

NetXMSClientException

java.io.IOException

renderReport

java.io.File renderReport(java.util.UUID reportId,
                        java.util.UUID jobId,
                        ReportRenderFormat format)
                          throws NetXMSClientException,
                                 java.io.IOException

Throws:

NetXMSClientException

java.io.IOException