com.esri.arcgis.geoprocessing
Class IGPCustomToolProxy

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

All Implemented Interfaces:

IGPCustomTool, Externalizable, Serializable

public class IGPCustomToolProxy
extends com.esri.arcgis.interop.Dispatch
implements IGPCustomTool, Serializable

Provides access to methods on a custom geoprocessing tool object.

Product Availability

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

See Also:

Serialized Form

Field Summary

boolean

noncastable

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

DISPATCH_METHOD, DISPATCH_PROPERTYGET, DISPATCH_PROPERTYPUT, DISPATCH_PROPERTYPUTREF, objRef

Constructor Summary

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

Method Summary

void	addListener(String iidStr, Object theListener, Object theSource)
IGPToolExtension	getToolExtension() The tool extension associated with the tool.
void	removeListener(String iidStr, Object theListener)
void	setToolExtensionByRef(IGPToolExtension extension) The tool extension associated with the tool.

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, optimizedVtblInvoke, queryInterface, readExternal, release, setNativeMode, setPropertyByName, toString, vtblInvoke, writeExternal

Methods inherited from class java.lang.Object

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

Field Detail

noncastable

public boolean noncastable

Constructor Detail

IGPCustomToolProxy

public IGPCustomToolProxy()

IGPCustomToolProxy

public IGPCustomToolProxy(Object obj)
                   throws IOException

Throws:

IOException

IGPCustomToolProxy

protected IGPCustomToolProxy(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

getToolExtension

public IGPToolExtension getToolExtension()
                                  throws IOException,
                                         AutomationException

The tool extension associated with the tool.

Product Availability

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

Specified by:

getToolExtension in interface IGPCustomTool

Returns:

A reference to a com.esri.arcgis.geoprocessing.IGPToolExtension

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setToolExtensionByRef

public void setToolExtensionByRef(IGPToolExtension extension)
                           throws IOException,
                                  AutomationException

The tool extension associated with the tool.

Product Availability

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

Specified by:

setToolExtensionByRef in interface IGPCustomTool

Parameters:

extension - A reference to a com.esri.arcgis.geoprocessing.IGPToolExtension (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.