com.esri.arcgis.geoprocessing
Interface IGPToolName

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

GPToolName, IGPToolNameProxy

public interface IGPToolName
extends java.io.Serializable

COM Interface 'IGPToolName'. Generated 3/19/2015 1:20:58 PM from 'C:\ArcGIS\COM\esriGeoprocessing.olb'

Description: 'Provides access to methods on a tool name object.' Generator Options: PromptForTypeLibraries = False ClashPrefix = esri_ LowerCaseMemberNames = True IDispatchOnly = False RetryOnReject = False AwtForOcxs = True ArraysAsObjects = False DontRenameSameMethods = False ImplementConflictingInterfaces = True ReuseMethods = True RenameConflictingInterfaceMethods = True GenBeanInfo = True GenerateJavadoc =

Field Summary

static java.lang.String	IID Deprecated. Internal use only
static int	IID3cabeaaf_91a8_4c02_aa2f_95c9e01d1682
static int	xxDummy Deprecated. Internal use only

Method Summary

java.lang.String	getDescription() The description of the tool name object.
IUID	getDialogCLSID() The CLSID of the dialog object of the tool name.
java.lang.String	getDisplayName() The display name of the tool name object.
IGPToolboxName	getToolboxName() The toolbox name of the tool name.
java.lang.String	getToolCategory() The category of the tool name object.
int	getToolType() The tool type of the tool name.
void	setDescription(java.lang.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(java.lang.String name) The display name of the tool name object.
void	setToolboxNameByRef(IGPToolboxName toolboxName) The toolbox name of the tool name.
void	setToolCategory(java.lang.String path) The category of the tool name object.
void	setToolType(int type) The tool type of the tool name.

Field Detail

IID3cabeaaf_91a8_4c02_aa2f_95c9e01d1682

static final int IID3cabeaaf_91a8_4c02_aa2f_95c9e01d1682

See Also:

Constant Field Values

xxDummy

static final int xxDummy

Deprecated. Internal use only

See Also:

Constant Field Values

IID

static final java.lang.String IID

Deprecated. Internal use only

See Also:

Constant Field Values

Method Detail

getDisplayName

java.lang.String getDisplayName()
                                throws java.io.IOException,
                                       AutomationException

The display name of the tool name object.

Returns:

The name

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDisplayName

void setDisplayName(java.lang.String name)
                    throws java.io.IOException,
                           AutomationException

The display name of the tool name object.

Parameters:

name - The name (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDescription

java.lang.String getDescription()
                                throws java.io.IOException,
                                       AutomationException

The description of the tool name object.

Returns:

The description

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDescription

void setDescription(java.lang.String description)
                    throws java.io.IOException,
                           AutomationException

The description of the tool name object.

Parameters:

description - The description (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getToolCategory

java.lang.String getToolCategory()
                                 throws java.io.IOException,
                                        AutomationException

The category of the tool name object.

Returns:

The path

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setToolCategory

void setToolCategory(java.lang.String path)
                     throws java.io.IOException,
                            AutomationException

The category of the tool name object.

Parameters:

path - The path (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getToolType

int getToolType()
                throws java.io.IOException,
                       AutomationException

The tool type of the tool name.

Returns:

A com.esri.arcgis.geoprocessing.esriGPToolType constant

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setToolType

void setToolType(int type)
                 throws java.io.IOException,
                        AutomationException

The tool type of the tool name.

Parameters:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getToolboxName

IGPToolboxName getToolboxName()
                              throws java.io.IOException,
                                     AutomationException

The toolbox name of the tool name.

Returns:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setToolboxNameByRef

void setToolboxNameByRef(IGPToolboxName toolboxName)
                         throws java.io.IOException,
                                AutomationException

The toolbox name of the tool name.

Parameters:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDialogCLSID

IUID getDialogCLSID()
                    throws java.io.IOException,
                           AutomationException

The CLSID of the dialog object of the tool name.

Returns:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDialogCLSIDByRef

void setDialogCLSIDByRef(IUID ppClsid)
                         throws java.io.IOException,
                                AutomationException

The CLSID of the dialog object of the tool name.

Parameters:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.