com.esri.arcgis.system
Class ESRIScriptEngine

java.lang.Object
  com.esri.arcgis.system.ESRIScriptEngine

All Implemented Interfaces:

com.esri.arcgis.interop.RemoteObjRef, IESRIScriptEngine, Serializable

public class ESRIScriptEngine
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IESRIScriptEngine

An object that creates ESRIScriptEngine instances.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

See Also:

Serialized Form

Constructor Summary

ESRIScriptEngine()
Constructs a ESRIScriptEngine using ArcGIS Engine.

ESRIScriptEngine(Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
ESRIScriptEngine theESRIScriptEngine = (ESRIScriptEngine) obj;

Method Summary

void	addCode(String scriptCode) The AddCode method.
boolean	equals(Object o) Compare this object with another
static String	getClsid() getClsid.
void	getError(int[] pLineNumber, int[] pCharacterPosition, String[] pErrorSourceCode, String[] pErrorDescription) The Error method.
String	getLanguage() The Script Language.
int	hashCode() the hashcode for this object
boolean	isAllowUI() The AllowUI method.
Object	run(String procedureName, Object[] pParameters) The Run method.
void	setAllowUI(boolean pAllowUI) The AllowUI method.
void	setLanguage(String pLanguage) The Script Language.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.esri.arcgis.interop.RemoteObjRef

getJintegraDispatch, release

Constructor Detail

ESRIScriptEngine

public ESRIScriptEngine()
                 throws IOException,
                        UnknownHostException

Constructs a ESRIScriptEngine using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

ESRIScriptEngine

public ESRIScriptEngine(Object obj)
                 throws IOException

Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
ESRIScriptEngine theESRIScriptEngine = (ESRIScriptEngine) obj;

Construct a ESRIScriptEngine using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to ESRIScriptEngine.

Parameters:

obj - an object returned from ArcGIS Engine or Server

Throws:

IOException - if there are interop problems

Method Detail

getClsid

public static String getClsid()

getClsid.

equals

public boolean equals(Object o)

Compare this object with another

Overrides:

equals in class Object

hashCode

public int hashCode()

the hashcode for this object

Overrides:

hashCode in class Object

getLanguage

public String getLanguage()
                   throws IOException,
                          AutomationException

The Script Language.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

getLanguage in interface IESRIScriptEngine

Returns:

The pLanguage

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setLanguage

public void setLanguage(String pLanguage)
                 throws IOException,
                        AutomationException

The Script Language.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

setLanguage in interface IESRIScriptEngine

Parameters:

pLanguage - The pLanguage (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isAllowUI

public boolean isAllowUI()
                  throws IOException,
                         AutomationException

The AllowUI method.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

isAllowUI in interface IESRIScriptEngine

Returns:

The pAllowUI

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setAllowUI

public void setAllowUI(boolean pAllowUI)
                throws IOException,
                       AutomationException

The AllowUI method.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

setAllowUI in interface IESRIScriptEngine

Parameters:

pAllowUI - The pAllowUI (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

addCode

public void addCode(String scriptCode)
             throws IOException,
                    AutomationException

The AddCode method.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

addCode in interface IESRIScriptEngine

Parameters:

scriptCode - The scriptCode (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

run

public Object run(String procedureName,
                  Object[] pParameters)
           throws IOException,
                  AutomationException

The Run method.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

run in interface IESRIScriptEngine

Parameters:

procedureName - The procedureName (in)

pParameters - An UNSUPPORTED non-automation type: 26 (in)

Returns:

A Variant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getError

public void getError(int[] pLineNumber,
                     int[] pCharacterPosition,
                     String[] pErrorSourceCode,
                     String[] pErrorDescription)
              throws IOException,
                     AutomationException

The Error method.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

getError in interface IESRIScriptEngine

Parameters:

pLineNumber - The pLineNumber (in)

pCharacterPosition - The pCharacterPosition (in)

pErrorSourceCode - The pErrorSourceCode (in)

pErrorDescription - The pErrorDescription (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.