Package com.inductiveautomation.reporting.common.api

Interface ReportRpc

All Known Implementing Classes:

ReportRpcImpl

public interface ReportRpc

RPC Interface for reporting operations.

Field Summary

Fields

Modifier and Type	Field	Description
static final ProtoRpcSerializer	SERIALIZER

Method Summary

Modifier and Type	Method	Description
List<String>	execute(String projectName, byte[] reportResource, byte[] reportSchedule, AbstractReportActionConfig distributionConfig, String reportName, String reportPath)	Executes a report.
Date	getLastRun(String projectName, String reportPath)	Returns the date the report was last run.
ReportExecutionData	getReportData(String projectName, String reportPath, ReportDataConfiguration dataConfig, Map<String,Object> parameters, Map<String,Object> extraConfig, boolean sampleData)	Retrieves data for a report.

Field Details

SERIALIZER

static final ProtoRpcSerializer SERIALIZER

Method Details

getReportData

ReportExecutionData getReportData(String projectName,
 String reportPath,
 ReportDataConfiguration dataConfig,
 Map<String,Object> parameters,
 Map<String,Object> extraConfig,
 boolean sampleData)
                           throws Exception

Retrieves data for a report.

Parameters:

projectName - The name of the project.

reportPath - The path to the report.

dataConfig - The data configuration for the report.

parameters - Parameters to pass to the report.

extraConfig - Extra configuration for the data collection.

sampleData - True if this is for sample data (e.g. for previewing in the designer).

Returns:

The execution data for the report.

Throws:

Exception - if data collection fails.

execute

List<String> execute(String projectName,
 byte[] reportResource,
 byte[] reportSchedule,
 AbstractReportActionConfig distributionConfig,
 String reportName,
 String reportPath)
              throws Exception

Executes a report.

Parameters:

projectName - The name of the project.

reportResource - The serialized report resource (XML).

reportSchedule - The serialized report schedule (XML).

distributionConfig - The distribution configuration.

reportName - The name of the report.

reportPath - The path of the report.

Returns:

A list of any error messages generated during execution.

Throws:

Exception - if execution fails.

getLastRun

Date getLastRun(String projectName,
 String reportPath)

Returns the date the report was last run.

Parameters:

projectName - The name of the project.

reportPath - The path to the report.

Returns:

The last run date, or null if it hasn't been run.