com.esri.arcgis.geoprocessing
Class IGPToolCommandHelperProxy

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

All Implemented Interfaces:

IGPToolCommandHelper, Externalizable, Serializable

Direct Known Subclasses:

IGPToolCommandHelper2Proxy

public class IGPToolCommandHelperProxy
extends com.esri.arcgis.interop.Dispatch
implements IGPToolCommandHelper, Serializable

Provides access to the properties and methods of a Geoprocessing Tool Command Helper 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

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

Method Summary

void	addListener(String iidStr, Object theListener, Object theSource)
IGPTool	getTool() The geoprocessing tool currently associated with the command.
void	removeListener(String iidStr, Object theListener)
void	setTool(IGPTool tool) Associates the command object with a particular tool to be executed when the command is invoked.
void	setToolByName(String toolbox, String tool) Associates the command object with a particular tool to be executed when the command is invoked.

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

IGPToolCommandHelperProxy

public IGPToolCommandHelperProxy()

IGPToolCommandHelperProxy

public IGPToolCommandHelperProxy(Object obj)
                          throws IOException

Throws:

IOException

IGPToolCommandHelperProxy

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

setTool

public void setTool(IGPTool tool)
             throws IOException,
                    AutomationException

Associates the command object with a particular tool to be executed when the command is invoked.

Product Availability

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

Supported Platforms

Windows

Specified by:

setTool in interface IGPToolCommandHelper

Parameters:

tool - A reference to a com.esri.arcgis.geoprocessing.IGPTool (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setToolByName

public void setToolByName(String toolbox,
                          String tool)
                   throws IOException,
                          AutomationException

Associates the command object with a particular tool to be executed when the command is invoked.

Product Availability

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

Supported Platforms

Windows

Specified by:

setToolByName in interface IGPToolCommandHelper

Parameters:

toolbox - The toolbox (in)

tool - The tool (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTool

public IGPTool getTool()
                throws IOException,
                       AutomationException

The geoprocessing tool currently associated with the command.

Product Availability

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

Supported Platforms

Windows

Specified by:

getTool in interface IGPToolCommandHelper

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.