com.esri.arcgis.geoprocessing
Interface IGPToolInfo

All Superinterfaces:

Serializable

All Known Implementing Classes:

GPToolInfo

public interface IGPToolInfo
extends Serializable

Provides access to the properties/methods of the tool information.

Product Availability

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

Method Summary

String	getCategory() The tool category.
String	getDisplayName() The tool display name.
IEnvelope	getExtent() The extent of the tool.
String	getHelp() The url to the tool help.
String	getName() The tool name.
IGPParameterInfos	getParameterInfo() The tool parameters.
void	setCategory(String category) The tool category.
void	setDisplayName(String name) The tool display name.
void	setExtentByRef(IEnvelope ppExtent) The extent of the tool.
void	setHelp(String helpUrl) The url to the tool help.
void	setName(String name) The tool name.
void	setParameterInfoByRef(IGPParameterInfos ppParameterInfos) The tool parameters.

Method Detail

getName

String getName()
               throws IOException,
                      AutomationException

The tool name.

Product Availability

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

Returns:

The name

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setName

void setName(String name)
             throws IOException,
                    AutomationException

The tool name.

Product Availability

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

Parameters:

name - The name (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDisplayName

String getDisplayName()
                      throws IOException,
                             AutomationException

The tool display name.

Product Availability

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

Returns:

The name

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDisplayName

void setDisplayName(String name)
                    throws IOException,
                           AutomationException

The tool display name.

Product Availability

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

Parameters:

name - The name (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCategory

String getCategory()
                   throws IOException,
                          AutomationException

The tool category.

Product Availability

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

Returns:

The category

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setCategory

void setCategory(String category)
                 throws IOException,
                        AutomationException

The tool category.

Product Availability

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

Parameters:

category - The category (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getHelp

String getHelp()
               throws IOException,
                      AutomationException

The url to the tool help.

Product Availability

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

Returns:

The helpUrl

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setHelp

void setHelp(String helpUrl)
             throws IOException,
                    AutomationException

The url to the tool help.

Product Availability

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

Parameters:

helpUrl - The helpUrl (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getParameterInfo

IGPParameterInfos getParameterInfo()
                                   throws IOException,
                                          AutomationException

The tool parameters.

Product Availability

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

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setParameterInfoByRef

void setParameterInfoByRef(IGPParameterInfos ppParameterInfos)
                           throws IOException,
                                  AutomationException

The tool parameters.

Product Availability

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

Parameters:

ppParameterInfos - A reference to a com.esri.arcgis.geoprocessing.IGPParameterInfos (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getExtent

IEnvelope getExtent()
                    throws IOException,
                           AutomationException

The extent of the tool.

Product Availability

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

Returns:

A reference to a com.esri.arcgis.geometry.IEnvelope

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setExtentByRef

void setExtentByRef(IEnvelope ppExtent)
                    throws IOException,
                           AutomationException

The extent of the tool.

Product Availability

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

Parameters:

ppExtent - A reference to a com.esri.arcgis.geometry.IEnvelope (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.