com.esri.arcgis.geoprocessing
Class IGPFunctionToolProxy

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

All Implemented Interfaces:

IGPFunctionTool, Externalizable, Serializable

public class IGPFunctionToolProxy
extends com.esri.arcgis.interop.Dispatch
implements IGPFunctionTool, Serializable

Provides access to methods on a geoprocessing function 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

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

Method Summary

void	addListener(String iidStr, Object theListener, Object theSource)
IGPFunction	getFunction() The function object associated with the tool.
void	removeListener(String iidStr, Object theListener)
void	setFunctionByRef(IGPFunction function) The function object 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

IGPFunctionToolProxy

public IGPFunctionToolProxy()

IGPFunctionToolProxy

public IGPFunctionToolProxy(Object obj)
                     throws IOException

Throws:

IOException

IGPFunctionToolProxy

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

getFunction

public IGPFunction getFunction()
                        throws IOException,
                               AutomationException

The function object associated with the tool.

Product Availability

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

Supported Platforms

Windows

Specified by:

getFunction in interface IGPFunctionTool

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setFunctionByRef

public void setFunctionByRef(IGPFunction function)
                      throws IOException,
                             AutomationException

The function object associated with the tool.

Product Availability

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

Specified by:

setFunctionByRef in interface IGPFunctionTool

Parameters:

function - A reference to a com.esri.arcgis.geoprocessing.IGPFunction (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.