ag.ion.noa.internal.script
Class Script

java.lang.Object
  ag.ion.noa.internal.script.Script

All Implemented Interfaces:

IScript

public class Script
extends java.lang.Object
implements IScript

Script of the office scripting framework which can be invoked.

Field Summary

Fields inherited from interface ag.ion.noa.script.IScript

EMPTY_ARRAY

Constructor Summary

Script(java.lang.String uri, com.sun.star.script.provider.XScript xScript)
Constructs a Script.

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.

Methods inherited from class java.lang.Object

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

Constructor Detail

Script

public Script(java.lang.String uri,
              com.sun.star.script.provider.XScript xScript)

Constructs a Script.

Parameters:

uri - the uri to be used

xScript - OpenOffice.org XScript interface to be used

Method Detail

getName

public java.lang.String getName()

Returns the name of the script.

Specified by:

getName in interface IScript

Returns:

the name of the script

getModuleName

public java.lang.String getModuleName()

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

Specified by:

getModuleName in interface IScript

Returns:

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

getLibraryName

public java.lang.String getLibraryName()

Returns the library name of the script.

Specified by:

getLibraryName in interface IScript

Returns:

the library name of the script

getLanguage

public java.lang.String getLanguage()

Returns the language of the script.

Specified by:

getLanguage in interface IScript

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

public java.lang.String getURI()

Returns the URI of the script as string.

Specified by:

getURI in interface IScript

Returns:

the URI of the script as string

getXScript

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

Returns OpenOffice.org XScript interface.

Specified by:

getXScript in interface IScript

Returns:

OpenOffice.org XScript interface

invoke

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

Invokes the script.

Specified by:

invoke in interface IScript

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

public java.lang.Object invoke()
                        throws NOAException

Invokes the script without parameters.

Specified by:

invoke in interface IScript

Returns:

output of the script

Throws:

NOAException - if the script can not be invoked