com.esri.arcgis.geoprocessing
Interface IGPToolCommandHelper

All Superinterfaces:

Serializable

All Known Subinterfaces:

IGPToolCommandHelper2

All Known Implementing Classes:

IGPToolCommandHelper2Proxy, IGPToolCommandHelperProxy

public interface IGPToolCommandHelper
extends 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.

Method Summary

IGPTool	getTool() The geoprocessing tool currently associated with the command.
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.

Method Detail

setTool

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

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

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

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

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

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.