Package com.inductiveautomation.reporting.gateway.actions

Class EmailAction

java.lang.Object

com.inductiveautomation.reporting.gateway.actions.AbstractReportAction

com.inductiveautomation.reporting.gateway.actions.EmailAction

public class EmailAction
extends AbstractReportAction

Constructor Summary

Constructors

Constructor	Description
EmailAction(GatewayContext context, java.lang.String projectName, ReportExecutionContext reportContext)

Method Summary

Modifier and Type	Method	Description
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> reportData)
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.

Methods inherited from class java.lang.Object

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

Constructor Detail

EmailAction

public EmailAction(GatewayContext context,
                   java.lang.String projectName,
                   ReportExecutionContext reportContext)

Method Detail

perform

public 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> reportData)

Specified by:

perform in class AbstractReportAction

perform

public 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)

Description copied from class: AbstractReportAction

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.

Specified by:

perform in class AbstractReportAction

Parameters:

report - The RMDocument generated from the report template

reportResource - The ReportResource

config - 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.