Class AbstractReportAction
- java.lang.Object
-
- com.inductiveautomation.reporting.gateway.actions.AbstractReportAction
-
- Direct Known Subclasses:
EmailAction
,FtpAction
,PrintAction
,RunScriptAction
,SaveFileReportAction
public abstract class AbstractReportAction extends java.lang.Object
Filename: AbstractReportAction.java Created on Feb 06, 2015 Author: Kathy Applebaum Copyright Inductive Automation 2015 Project: ReportingWhen making subclasses of this, be sure to add them to the map in ReportSchedulerTask.java
-
-
Constructor Summary
Constructors Constructor Description AbstractReportAction(GatewayContext context, java.lang.String projectName, ReportExecutionContext reportContext)
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description abstract void
perform(RMDocument report, ReportResource reportResource, AbstractReportActionConfig config, java.lang.String reportPath, java.lang.String reportName, java.util.Map<java.lang.String,java.lang.Object> parameterData)
abstract void
perform(RMDocument report, ReportResource reportResource, AbstractReportActionConfig config, java.lang.String reportPath, java.lang.String reportName, java.util.Map<java.lang.String,java.lang.Object> parameterData, java.util.Map<java.lang.String,java.lang.Object> configData)
Called by system.report.executeAndDistribute.
-
-
-
Constructor Detail
-
AbstractReportAction
public AbstractReportAction(GatewayContext context, java.lang.String projectName, ReportExecutionContext reportContext)
-
-
Method Detail
-
perform
public abstract void perform(RMDocument report, ReportResource reportResource, AbstractReportActionConfig config, java.lang.String reportPath, java.lang.String reportName, java.util.Map<java.lang.String,java.lang.Object> parameterData)
-
perform
public abstract void perform(RMDocument report, ReportResource reportResource, AbstractReportActionConfig config, java.lang.String reportPath, java.lang.String reportName, java.util.Map<java.lang.String,java.lang.Object> parameterData, @Nonnull java.util.Map<java.lang.String,java.lang.Object> configData)
Called by system.report.executeAndDistribute. This parses the configData that applies to this distribution type, updates a distribution config, and calls the other overload of perform.- Parameters:
report
- The RMDocument generated from the report templatereportResource
- The ReportResourceconfig
- A new blank config of the appropriate type. May be altered by the configData before calling the overload.reportPath
- Path to the report we want to perform.reportName
- Name of the report we want to perform.parameterData
- Optional parameter overrides.configData
- Optional data to apply to the configuration. Missing values will be left at the default values.
-
-