Package com.inductiveautomation.ignition.common.script.message

Class MessageHandlerTask

java.lang.Object

com.inductiveautomation.ignition.common.script.message.MessageHandlerTask

public class MessageHandlerTask
extends java.lang.Object

Holds everything needed to execute a MessageHandler runnable. Pass an instance of this to a runnable configured with message parameters.

Constructor Summary

Constructors

Constructor	Description
MessageHandlerTask(MessageHandlerManager messageManager, java.lang.String projectName, MessageHandlerKey key, ScriptManager manager, IScriptsEnabled scriptsEnabled, java.lang.String code)

Method Summary

Modifier and Type	Method	Description
org.python.core.PyCode	getCompiledJyCode()
java.lang.String	getLastRunErrMsg()
MessageHandlerKey	getMessageHandlerKey()
MessageHandlerManager	getMessageHandlerManager()
java.lang.String	getProjectName()
java.lang.String	getScriptCode()	Returns the user-provided Jython script code
ScriptManager	getScriptManager()
boolean	isDontCompile()	Returns true if a previous attempt to compile the code has failed
boolean	isScriptsEnabled()
void	reportExecution(MessageHandlerKey key, ScriptExecutionReport report)	Updates the execution status of a MessageHandlerRunnable
void	setCompiledJyCode(org.python.core.PyCode compiledJyCode)
void	setDontCompile(boolean dontCompile)	Set to true if an attempt to compile the code has failed
void	setLastRunErrMsg(java.lang.String lastRunErrMsg)

Methods inherited from class java.lang.Object

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

Constructor Detail

MessageHandlerTask

public MessageHandlerTask(MessageHandlerManager messageManager,
                          java.lang.String projectName,
                          MessageHandlerKey key,
                          ScriptManager manager,
                          IScriptsEnabled scriptsEnabled,
                          java.lang.String code)

Method Detail

getMessageHandlerManager

public MessageHandlerManager getMessageHandlerManager()

getProjectName

public java.lang.String getProjectName()

getScriptCode

public java.lang.String getScriptCode()

Returns the user-provided Jython script code

getMessageHandlerKey

public MessageHandlerKey getMessageHandlerKey()

getCompiledJyCode

public org.python.core.PyCode getCompiledJyCode()

setCompiledJyCode

public void setCompiledJyCode(org.python.core.PyCode compiledJyCode)

isDontCompile

public boolean isDontCompile()

Returns true if a previous attempt to compile the code has failed

setDontCompile

public void setDontCompile(boolean dontCompile)

Set to true if an attempt to compile the code has failed

getScriptManager

public ScriptManager getScriptManager()

isScriptsEnabled

public boolean isScriptsEnabled()

Returns:

true if: ((FPMISystem.getMode() == FPMISystem.Mode.PREVIEW && !FPMISystem.isSerializing()) OR (FPMISystem.getMode() == FPMISystem.Mode.RUNTIME && FPMISystem.isLoggedIn()))

getLastRunErrMsg

public java.lang.String getLastRunErrMsg()

setLastRunErrMsg

public void setLastRunErrMsg(java.lang.String lastRunErrMsg)

reportExecution

public void reportExecution(MessageHandlerKey key,
                            ScriptExecutionReport report)

Updates the execution status of a MessageHandlerRunnable