com.esri.arcgis.geoprocessing
Interface IGPToolName

All Superinterfaces:

Serializable

All Known Implementing Classes:

GPToolName

public interface IGPToolName
extends Serializable

Provides access to methods on a tool name object.

Product Availability

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

Method Summary

String	getDescription() The description of the tool name object.
IUID	getDialogCLSID() The CLSID of the dialog object of the tool name.
String	getDisplayName() The display name of the tool name object.
IGPToolboxName	getToolboxName() The toolbox name of the tool name.
String	getToolCategory() The category of the tool name object.
int	getToolType() The tool type of the tool name.
void	setDescription(String description) The description of the tool name object.
void	setDialogCLSIDByRef(IUID ppClsid) The CLSID of the dialog object of the tool name.
void	setDisplayName(String name) The display name of the tool name object.
void	setToolboxNameByRef(IGPToolboxName toolboxName) The toolbox name of the tool name.
void	setToolCategory(String path) The category of the tool name object.
void	setToolType(int type) The tool type of the tool name.

Method Detail

getDisplayName

String getDisplayName()
                      throws IOException,
                             AutomationException

The display name of the tool name object.

Product Availability

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

Supported Platforms

Windows

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 display name of the tool name object.

Product Availability

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

Supported Platforms

Windows

Parameters:

name - The name (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDescription

String getDescription()
                      throws IOException,
                             AutomationException

The description of the tool name object.

Product Availability

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

Supported Platforms

Windows

Returns:

The description

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDescription

void setDescription(String description)
                    throws IOException,
                           AutomationException

The description of the tool name object.

Product Availability

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

Supported Platforms

Windows

Parameters:

description - The description (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getToolCategory

String getToolCategory()
                       throws IOException,
                              AutomationException

The category of the tool name object.

Product Availability

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

Supported Platforms

Windows

Returns:

The path

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setToolCategory

void setToolCategory(String path)
                     throws IOException,
                            AutomationException

The category of the tool name object.

Product Availability

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

Supported Platforms

Windows

Parameters:

path - The path (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getToolType

int getToolType()
                throws IOException,
                       AutomationException

The tool type of the tool name.

Product Availability

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

Supported Platforms

Windows

Returns:

A com.esri.arcgis.geoprocessing.esriGPToolType constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setToolType

void setToolType(int type)
                 throws IOException,
                        AutomationException

The tool type of the tool name.

Product Availability

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

Supported Platforms

Windows

Parameters:

type - A com.esri.arcgis.geoprocessing.esriGPToolType constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getToolboxName

IGPToolboxName getToolboxName()
                              throws IOException,
                                     AutomationException

The toolbox name of the tool name.

Product Availability

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

Supported Platforms

Windows

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setToolboxNameByRef

void setToolboxNameByRef(IGPToolboxName toolboxName)
                         throws IOException,
                                AutomationException

The toolbox name of the tool name.

Product Availability

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

Parameters:

toolboxName - A reference to a com.esri.arcgis.geoprocessing.IGPToolboxName (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDialogCLSID

IUID getDialogCLSID()
                    throws IOException,
                           AutomationException

The CLSID of the dialog object of the tool name.

Product Availability

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

Supported Platforms

Windows

Returns:

A reference to a com.esri.arcgis.system.IUID

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDialogCLSIDByRef

void setDialogCLSIDByRef(IUID ppClsid)
                         throws IOException,
                                AutomationException

The CLSID of the dialog object of the tool name.

Product Availability

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

Parameters:

ppClsid - A reference to a com.esri.arcgis.system.IUID (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.