com.esri.arcgis.geoprocessing
Interface IGPToolInfo

All Superinterfaces:
java.io.Serializable
All Known Implementing Classes:
GPToolInfo, IGPToolInfoProxy

public interface IGPToolInfo
extends java.io.Serializable

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

Description: 'Provides access to the properties/methods of the tool information.' 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 IIDe4f9e74d_957a_471e_9c4a_6339fee513be
           
static int xxDummy
          Deprecated. Internal use only
 
Method Summary
 java.lang.String getCategory()
          The tool category.
 java.lang.String getDisplayName()
          The tool display name.
 IEnvelope getExtent()
          The extent of the tool.
 java.lang.String getHelp()
          The url to the tool help.
 java.lang.String getName()
          The tool name.
 IGPParameterInfos getParameterInfo()
          The tool parameters.
 void setCategory(java.lang.String category)
          The tool category.
 void setDisplayName(java.lang.String name)
          The tool display name.
 void setExtentByRef(IEnvelope ppExtent)
          The extent of the tool.
 void setHelp(java.lang.String helpUrl)
          The url to the tool help.
 void setName(java.lang.String name)
          The tool name.
 void setParameterInfoByRef(IGPParameterInfos ppParameterInfos)
          The tool parameters.
 

Field Detail

IIDe4f9e74d_957a_471e_9c4a_6339fee513be

static final int IIDe4f9e74d_957a_471e_9c4a_6339fee513be
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

getName

java.lang.String getName()
                         throws java.io.IOException,
                                AutomationException
The tool name.

Returns:
The name
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setName

void setName(java.lang.String name)
             throws java.io.IOException,
                    AutomationException
The tool name.

Parameters:
name - The name (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getDisplayName

java.lang.String getDisplayName()
                                throws java.io.IOException,
                                       AutomationException
The tool display name.

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

Parameters:
name - The name (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getCategory

java.lang.String getCategory()
                             throws java.io.IOException,
                                    AutomationException
The tool category.

Returns:
The category
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setCategory

void setCategory(java.lang.String category)
                 throws java.io.IOException,
                        AutomationException
The tool category.

Parameters:
category - The category (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getHelp

java.lang.String getHelp()
                         throws java.io.IOException,
                                AutomationException
The url to the tool help.

Returns:
The helpUrl
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setHelp

void setHelp(java.lang.String helpUrl)
             throws java.io.IOException,
                    AutomationException
The url to the tool help.

Parameters:
helpUrl - The helpUrl (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getParameterInfo

IGPParameterInfos getParameterInfo()
                                   throws java.io.IOException,
                                          AutomationException
The tool parameters.

Returns:
A reference to a com.esri.arcgis.geoprocessing.IGPParameterInfos
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setParameterInfoByRef

void setParameterInfoByRef(IGPParameterInfos ppParameterInfos)
                           throws java.io.IOException,
                                  AutomationException
The tool parameters.

Parameters:
ppParameterInfos - A reference to a com.esri.arcgis.geoprocessing.IGPParameterInfos (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getExtent

IEnvelope getExtent()
                    throws java.io.IOException,
                           AutomationException
The extent of the tool.

Returns:
A reference to a com.esri.arcgis.geometry.IEnvelope
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setExtentByRef

void setExtentByRef(IEnvelope ppExtent)
                    throws java.io.IOException,
                           AutomationException
The extent of the tool.

Parameters:
ppExtent - A reference to a com.esri.arcgis.geometry.IEnvelope (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.