Package com.inductiveautomation.reporting.gateway.rpc

Class ReportRpcImpl

java.lang.Object

com.inductiveautomation.reporting.gateway.rpc.ReportRpcImpl

All Implemented Interfaces:

ReportRpc

public class ReportRpcImpl
extends Object
implements ReportRpc

Field Summary

Fields inherited from interface com.inductiveautomation.reporting.common.api.ReportRpc

SERIALIZER

Constructor Summary

Constructors

Constructor	Description
ReportRpcImpl(ReportingGatewayHook hook)

Method Summary

Modifier and Type	Method	Description
List<String>	execute(String projectName, byte[] reportResourceBytes, byte[] reportScheduleBytes, AbstractReportActionConfig actionConfig, 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.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

ReportRpcImpl

public ReportRpcImpl(ReportingGatewayHook hook)

Method Details

getReportData

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

Description copied from interface: ReportRpc

Retrieves data for a report.

Specified by:

getReportData in interface ReportRpc

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

public List<String> execute(String projectName,
 byte[] reportResourceBytes,
 byte[] reportScheduleBytes,
 AbstractReportActionConfig actionConfig,
 String reportName,
 String reportPath)
                     throws Exception

Description copied from interface: ReportRpc

Executes a report.

Specified by:

execute in interface ReportRpc

Parameters:

projectName - The name of the project.

reportResourceBytes - The serialized report resource (XML).

reportScheduleBytes - The serialized report schedule (XML).

actionConfig - 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

public Date getLastRun(String projectName,
 String reportPath)

Description copied from interface: ReportRpc

Returns the date the report was last run.

Specified by:

getLastRun in interface ReportRpc

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.