sae.ScriptProcessor Interface Reference

import "saescript.idl";

Inheritance diagram for sae.ScriptProcessor:

List of all members.

Public Member Functions
void	install (in string scriptName, in wstring script, in boolean force) raises (ScriptSyntaxError, OperationFailed)
	Install and compile a script without executing it.
wstring	execute (in string scriptName, in Arguments args) raises (ScriptExecutionError, OperationFailed)
	execute a previously installed script.
wstring	execOne (in string script, in Arguments args) raises (ScriptSyntaxError, ScriptExecutionError, OperationFailed)
	Execute a script without installing it.
void	uninstall (in string scriptName) raises (OperationFailed)
	Remove a previously installed script.
StringSeq	listInstalledScripts ()
	list currently installed scripts

---

Member Function Documentation

wstring sae.ScriptProcessor.execOne	(	in string	script,
		in Arguments	args
	)			raises (ScriptSyntaxError, ScriptExecutionError, OperationFailed)

Execute a script without installing it.

Note:

the operation is optional. If a particular ScriptProcessor does not support single execution, an OperationFailed exception will be raised.

Parameters:

[in]	script	the source code of the script.
[in]	args	a list of arguments passed to the script

Returns:

a string returned from the script

Exceptions:

	ScriptExecutionError	if the execution of the script failed.
	OperationFailed	if the script could not be executed.

wstring sae.ScriptProcessor.execute	(	in string	scriptName,
		in Arguments	args
	)			raises (ScriptExecutionError, OperationFailed)

execute a previously installed script.

Parameters:

[in]	scriptName	the name of the script
[in]	args	a list of arguments passed to the script

Returns:

a string returned from the script

Exceptions:

	ScriptExecutionError	if the execution of the script failed.
	OperationFailed	if the script could not be executed.

void sae.ScriptProcessor.install	(	in string	scriptName,
		in wstring	script,
		in boolean	force
	)			raises (ScriptSyntaxError, OperationFailed)

Install and compile a script without executing it.

Parameters:

[in]	scriptName	the name under which the script is installed.
[in]	script	the source code of the script.
[in]	force	if set to true, overwrite the script if it already exists.

Exceptions:

	ScriptSyntaxError	if the script could not be compiled
	OperationFailed	if the script could not be installed

StringSeq sae.ScriptProcessor.listInstalledScripts

(

)

list currently installed scripts

Returns:

list of installed script names.

void sae.ScriptProcessor.uninstall

(

in string

scriptName

)

raises (OperationFailed)

Remove a previously installed script.

Parameters:

[in]

scriptName

the name of the script

Exceptions:

OperationFailed

if the script could not be removed.

---

The documentation for this interface was generated from the following file:

• saescript.idl