org.da.protoframework.uaappli.script.context

Class UAScriptContext

java.lang.Object

org.scripthelper.context.DefaultScriptContext

org.da.protoframework.uaappli.script.context.UAScriptContext

All Implemented Interfaces:

org.scripthelper.context.ScriptContext

public class UAScriptContext
extends org.scripthelper.context.DefaultScriptContext

A Script Context passed to Scripts

Constructor Summary

Constructors

Constructor and Description
UAScriptContext(org.da.protoframework.model.core.Module module, java.net.URL scriptURL, ScriptedFunctionalUA ua) Create a new ScriptContext.

Method Summary

Modifier and Type	Method and Description
void	echo(java.lang.String message) Echo a message.
void	end() Called automatically by the Scripting framework at the end of the Script.
void	error(java.lang.String message) echo a warning (in red).
arinc661.client.api.StatefullAPI	getAPI()
UAScriptHelper	getHelper() Return the ScriptHelper, which provides several utility methods.
org.da.protoframework.model.core.Module	getModule()
java.net.URL	getScriptURL() Return the associated Script file.
void	setAPI(arinc661.client.api.StatefullAPI api)
void	setLogger(org.da.protoframework.conf.FrameworkLogger logger) Set the associated ScriptLogger.

Methods inherited from class org.scripthelper.context.DefaultScriptContext

__step__, abort, echo, getPath, getScriptLogger, getScriptSource, getScriptWrapper, setLogger, setScriptSource, setScriptWrapper

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.scripthelper.context.ScriptContext

clearTab, echo, echo, getScriptFile, setProgress, setTab

Constructor Detail

UAScriptContext

public UAScriptContext(org.da.protoframework.model.core.Module module,
                       java.net.URL scriptURL,
                       ScriptedFunctionalUA ua)

Create a new ScriptContext.

Parameters:

module - the module

scriptURL - the script URL

ua - the UA

Method Detail

setAPI

public void setAPI(arinc661.client.api.StatefullAPI api)

getAPI

public arinc661.client.api.StatefullAPI getAPI()

getScriptURL

public java.net.URL getScriptURL()

Return the associated Script file.

Returns:

the associated Script file

end

public void end()

Called automatically by the Scripting framework at the end of the Script.

setLogger

public void setLogger(org.da.protoframework.conf.FrameworkLogger logger)

Set the associated ScriptLogger.

Parameters:

logger - the associated ScriptLogger

getHelper

public UAScriptHelper getHelper()

Return the ScriptHelper, which provides several utility methods.

Returns:

the ScriptHelper

getModule

public org.da.protoframework.model.core.Module getModule()

echo

public void echo(java.lang.String message)

Echo a message.

Specified by:

echo in interface org.scripthelper.context.ScriptContext

Overrides:

echo in class org.scripthelper.context.DefaultScriptContext

Parameters:

message - the message text

error

public void error(java.lang.String message)

echo a warning (in red).

Specified by:

error in interface org.scripthelper.context.ScriptContext

Overrides:

error in class org.scripthelper.context.DefaultScriptContext

Parameters:

message - the message text