Package com.inductiveautomation.ignition.gateway.project

Interface LegacyProjectScriptManager

public interface LegacyProjectScriptManager

Method Summary

Modifier and Type	Method	Description
java.util.List<ProjectScriptDiagnostic>	getProjectScriptDiagnostics(java.lang.String projectName, int type)	Get the ProjectScriptDiagnostic for a Project.
java.util.List<ScriptExecutionReport>	getProjectScriptExecutionReports(java.lang.String projectName)
void	invokeGWMessageHandler(java.lang.String projectName, java.lang.String messageHandlerName, org.python.core.PyDictionary messageParams, MessageResultHandler handler, java.util.Properties properties)	Invokes the specified Gateway message handler on a project.

Method Detail

getProjectScriptDiagnostics

java.util.List<ProjectScriptDiagnostic> getProjectScriptDiagnostics(java.lang.String projectName,
                                                                    int type)

Get the ProjectScriptDiagnostic for a Project.

Parameters:

projectName - the name of the Project.

type - the diagnostic type.

Returns:

the ProjectScriptDiagnostic for projectName.

getProjectScriptExecutionReports

java.util.List<ScriptExecutionReport> getProjectScriptExecutionReports(java.lang.String projectName)

Parameters:

projectName - The name of the Project.

Returns:

The current list of ScriptExecutionReports for the project specified by projectId.

invokeGWMessageHandler

void invokeGWMessageHandler(java.lang.String projectName,
                            java.lang.String messageHandlerName,
                            org.python.core.PyDictionary messageParams,
                            MessageResultHandler handler,
                            java.util.Properties properties)
                     throws MessageHandlerException

Invokes the specified Gateway message handler on a project. The messageParams PyDictionary object is passed to the message handler.

Parameters:

projectName - The project name.

messageHandlerName - The name of the Gateway message handler in the Project.

messageParams - a PyDictionary that is passed to the message handler. See MessageDispatchManager for details.

handler - a result handler. May be null.

properties - Contains associated properties, like originating user and zone. May be null.

Throws:

MessageHandlerException - if the message handler cannot be found in the project or some other problem occurred.