ag.ion.noa.script
Interface IScript

All Known Implementing Classes:

Script

public interface IScript

Script of the office scripting framework which can be invoked.

Field Summary

static IScript[]

EMPTY_ARRAY Empty array of scripts.

Method Summary

java.lang.String	getLanguage() Returns the language of the script.
java.lang.String	getLibraryName() Returns the library name of the script.
java.lang.String	getModuleName() Returns the module name of the script, or null if not TYPE_BASIC.
java.lang.String	getName() Returns the name of the script.
java.lang.String	getURI() Returns the URI of the script as string.
com.sun.star.script.provider.XScript	getXScript() Returns OpenOffice.org XScript interface.
java.lang.Object	invoke() Invokes the script without parameters.
java.lang.Object	invoke(java.lang.Object[] parameters, short[][] outParameterIndices, java.lang.Object[][] outParameters) Invokes the script.

Field Detail

EMPTY_ARRAY

static final IScript[] EMPTY_ARRAY

Empty array of scripts.

Method Detail

getName

java.lang.String getName()

Returns the name of the script.

Returns:

the name of the script

getModuleName

java.lang.String getModuleName()

Returns the module name of the script, or null if not TYPE_BASIC.

Returns:

the module name of the script, or null if not TYPE_BASIC

getLibraryName

java.lang.String getLibraryName()

Returns the library name of the script.

Returns:

the library name of the script

getLanguage

java.lang.String getLanguage()

Returns the language of the script.

Returns:

the language of the script

See Also:

IScriptProvider.TYPE_BASIC, IScriptProvider.TYPE_BEAN_SHELL, IScriptProvider.TYPE_JAVA, IScriptProvider.TYPE_JAVA_SCRIPT, IScriptProvider.TYPE_PYTHON

getURI

java.lang.String getURI()

Returns the URI of the script as string.

Returns:

the URI of the script as string

getXScript

com.sun.star.script.provider.XScript getXScript()

Returns OpenOffice.org XScript interface.

Returns:

OpenOffice.org XScript interface

invoke

java.lang.Object invoke(java.lang.Object[] parameters,
                        short[][] outParameterIndices,
                        java.lang.Object[][] outParameters)
                        throws NOAException

Invokes the script.

Parameters:

parameters - parameters to be used for script invocation

outParameterIndices - indices of output related parameters within the parameters

outParameters - storage for out parameters

Returns:

output of the script

Throws:

NOAException - if the script can not be invoked

invoke

java.lang.Object invoke()
                        throws NOAException

Invokes the script without parameters.

Returns:

output of the script

Throws:

NOAException - if the script can not be invoked