Class ReportExecutionContext
- java.lang.Object
-
- com.inductiveautomation.reporting.gateway.api.ReportExecutionContext
-
public final class ReportExecutionContext extends java.lang.Object
Created by carl.gould on 3/3/2015.Classes that want to be notified when the execution status changes (as opposed to just checking the status at convenient points) can register a listener with addStatusChangeListener()
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
ReportExecutionContext.ReportExecutionContextBuilder
Builder pattern because the number of parameters is getting to be insane.static class
ReportExecutionContext.ReportLoggerEx
ReportLoggerEx is a logging class that extends LoggerEx to add errors to the ReportExecutionData's error list when a WARN or ERROR level messages are logged.
-
Field Summary
Fields Modifier and Type Field Description static java.lang.String
STATUS_CHANGE_PROP
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description void
addActionFailure(java.lang.String failure)
void
addStatusChangeListener(java.beans.PropertyChangeListener listener)
static ReportExecutionContext.ReportExecutionContextBuilder
builder(GatewayContext context, ReportStatusManager statusManager)
Builder pattern because the number of parameters is getting to be insane.QualifiedValue
executeExpression(java.lang.String expression)
QualifiedValue
executeExpression(java.lang.String expression, ExpressionParseContext parseContext)
Executes an expression found in a report parameter/query and returns a QualifiedValuejava.util.List<java.lang.String>
getActionFailures()
GatewayContext
getContext()
java.lang.String
getDefaultDatabase()
java.util.Date
getExecutionCompleted()
ReportExecutionData
getExecutionData()
java.util.Date
getExecutionStarted()
ReportExecutionStatus
getExecutionStatus()
ReportExecutionContext.ReportLoggerEx
getLog()
java.lang.String
getProjectName()
java.lang.String
getReportPath()
ProjectResourceId
getResourceId()
ScriptManager
getScriptManager()
java.util.UUID
getUuid()
boolean
isAuditable()
boolean
isCanceled()
boolean
isError()
boolean
isFinishing()
boolean
isSample()
boolean
isScheduled()
void
notifyFinished()
void
removeStatusChangeListener(java.beans.PropertyChangeListener listener)
void
setExecutionCompleted(java.util.Date executionCompleted)
void
setExecutionStatus(ReportExecutionStatus executionStatus)
void
setIsAuditable(boolean isAuditable)
void
setIsScheduled(boolean isScheduled)
-
-
-
Field Detail
-
STATUS_CHANGE_PROP
public static final java.lang.String STATUS_CHANGE_PROP
- See Also:
- Constant Field Values
-
-
Method Detail
-
getScriptManager
public ScriptManager getScriptManager()
-
builder
public static ReportExecutionContext.ReportExecutionContextBuilder builder(GatewayContext context, ReportStatusManager statusManager)
Builder pattern because the number of parameters is getting to be insane.
-
executeExpression
public QualifiedValue executeExpression(java.lang.String expression) throws java.lang.Exception
- Throws:
java.lang.Exception
-
executeExpression
public QualifiedValue executeExpression(java.lang.String expression, ExpressionParseContext parseContext) throws java.lang.Exception
Executes an expression found in a report parameter/query and returns a QualifiedValue- Throws:
java.lang.Exception
-
getContext
public GatewayContext getContext()
-
getDefaultDatabase
public java.lang.String getDefaultDatabase()
-
getReportPath
public java.lang.String getReportPath()
-
getUuid
public java.util.UUID getUuid()
-
getExecutionStatus
public ReportExecutionStatus getExecutionStatus()
-
setExecutionStatus
public void setExecutionStatus(ReportExecutionStatus executionStatus)
-
getExecutionStarted
public java.util.Date getExecutionStarted()
-
getExecutionCompleted
public java.util.Date getExecutionCompleted()
-
setExecutionCompleted
public void setExecutionCompleted(java.util.Date executionCompleted)
-
isSample
public boolean isSample()
-
isScheduled
public boolean isScheduled()
-
setIsScheduled
public void setIsScheduled(boolean isScheduled)
-
setIsAuditable
public void setIsAuditable(boolean isAuditable)
-
isAuditable
public boolean isAuditable()
-
getExecutionData
public ReportExecutionData getExecutionData()
-
getLog
public ReportExecutionContext.ReportLoggerEx getLog()
-
notifyFinished
public void notifyFinished()
-
isFinishing
public boolean isFinishing()
-
isCanceled
public boolean isCanceled()
-
isError
public boolean isError()
-
addStatusChangeListener
public void addStatusChangeListener(java.beans.PropertyChangeListener listener)
-
removeStatusChangeListener
public void removeStatusChangeListener(java.beans.PropertyChangeListener listener)
-
addActionFailure
public void addActionFailure(java.lang.String failure)
-
getActionFailures
public java.util.List<java.lang.String> getActionFailures()
-
getProjectName
public java.lang.String getProjectName()
-
getResourceId
public ProjectResourceId getResourceId()
-
-