com.esri.arcgis.geoprocessing
Class IGPScriptToolProxy

java.lang.Object
  com.esri.arcgis.interop.Dispatch
      com.esri.arcgis.geoprocessing.IGPScriptToolProxy

All Implemented Interfaces:

IGPScriptTool, Externalizable, Serializable

public class IGPScriptToolProxy
extends com.esri.arcgis.interop.Dispatch
implements IGPScriptTool, Serializable

Provides access to methods on a geoprocessing script tool object.

Product Availability

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

Supported Platforms

Windows

See Also:

Serialized Form

Field Summary

Fields inherited from class com.esri.arcgis.interop.Dispatch

DISPATCH_METHOD, DISPATCH_PROPERTYGET, DISPATCH_PROPERTYPUT, DISPATCH_PROPERTYPUTREF, E

Constructor Summary

	IGPScriptToolProxy()
	IGPScriptToolProxy(Object obj)
protected	IGPScriptToolProxy(Object obj, String iid)

Method Summary

void	addListener(String iidStr, Object theListener, Object theSource)
IArray	getEnvironments() The environments associated with the tool.
String	getFileName() The name of the script file associated with the tool.
boolean	isShowCommandWindow() Indicates whether or not to display a command window when executing.
void	readExternal(ObjectInput in)
void	removeListener(String iidStr, Object theListener)
void	setEnvironmentsByRef(IArray environments) The environments associated with the tool.
void	setFileName(String name) The name of the script file associated with the tool.
void	setParameterInfoByRef(IArray rhs1) The parameters associated with the tool.
void	setShowCommandWindow(boolean showWindow) Indicates whether or not to display a command window when executing.
void	writeExternal(ObjectOutput out)

Methods inherited from class com.esri.arcgis.interop.Dispatch

bindUsingMoniker, constructVtblPosTable, convertToNative, cookieForListener, createDispatch, createObjrefMonikerDisplayName, equals, getActiveObject, getActiveObject, getDefaultProperty, getDispatchIdOfName, getLastErrorCode, getMtsObjectContext, getObjRef, getPropertyByName, getPropertyByName, getVtblPos, hashCode, initDispatch, invoke, invokeMethodByName, invokeMethodByName, invokeMethodByName, invokePropertyGetByName, invokePropertyPutByName, invokePropertyPutByRefByName, isNativeMode, isObjRef, queryInterface, release, setNativeMode, setPropertyByName, toString, vtblInvoke

Methods inherited from class java.lang.Object

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

Constructor Detail

IGPScriptToolProxy

public IGPScriptToolProxy()

IGPScriptToolProxy

public IGPScriptToolProxy(Object obj)
                   throws IOException

Throws:

IOException

IGPScriptToolProxy

protected IGPScriptToolProxy(Object obj,
                             String iid)
                      throws IOException

Throws:

IOException

Method Detail

addListener

public void addListener(String iidStr,
                        Object theListener,
                        Object theSource)
                 throws IOException

Overrides:

addListener in class com.esri.arcgis.interop.Dispatch

Throws:

IOException

removeListener

public void removeListener(String iidStr,
                           Object theListener)
                    throws IOException

Overrides:

removeListener in class com.esri.arcgis.interop.Dispatch

Throws:

IOException

getFileName

public String getFileName()
                   throws IOException,
                          AutomationException

The name of the script file associated with the tool.

Product Availability

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

Supported Platforms

Windows

Specified by:

getFileName in interface IGPScriptTool

Returns:

The name

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setFileName

public void setFileName(String name)
                 throws IOException,
                        AutomationException

The name of the script file associated with the tool.

Product Availability

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

Supported Platforms

Windows

Specified by:

setFileName in interface IGPScriptTool

Parameters:

name - The name (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setParameterInfoByRef

public void setParameterInfoByRef(IArray rhs1)
                           throws IOException,
                                  AutomationException

The parameters associated with the tool.

Product Availability

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

Specified by:

setParameterInfoByRef in interface IGPScriptTool

Parameters:

rhs1 - A reference to a com.esri.arcgis.system.IArray (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getEnvironments

public IArray getEnvironments()
                       throws IOException,
                              AutomationException

The environments associated with the tool.

Product Availability

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

Supported Platforms

Windows

Specified by:

getEnvironments in interface IGPScriptTool

Returns:

A reference to a com.esri.arcgis.system.IArray

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setEnvironmentsByRef

public void setEnvironmentsByRef(IArray environments)
                          throws IOException,
                                 AutomationException

The environments associated with the tool.

Product Availability

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

Specified by:

setEnvironmentsByRef in interface IGPScriptTool

Parameters:

environments - A reference to a com.esri.arcgis.system.IArray (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isShowCommandWindow

public boolean isShowCommandWindow()
                            throws IOException,
                                   AutomationException

Indicates whether or not to display a command window when executing.

Product Availability

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

Supported Platforms

Windows

Specified by:

isShowCommandWindow in interface IGPScriptTool

Returns:

The showWindow

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setShowCommandWindow

public void setShowCommandWindow(boolean showWindow)
                          throws IOException,
                                 AutomationException

Indicates whether or not to display a command window when executing.

Product Availability

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

Supported Platforms

Windows

Specified by:

setShowCommandWindow in interface IGPScriptTool

Parameters:

showWindow - The showWindow (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

writeExternal

public void writeExternal(ObjectOutput out)
                   throws IOException

Specified by:

writeExternal in interface Externalizable

Overrides:

writeExternal in class com.esri.arcgis.interop.Dispatch

Throws:

IOException

readExternal

public void readExternal(ObjectInput in)
                  throws IOException,
                         ClassNotFoundException

Specified by:

readExternal in interface Externalizable

Overrides:

readExternal in class com.esri.arcgis.interop.Dispatch

Throws:

IOException

ClassNotFoundException