com.esri.arcgis.catalog
Interface IGxGPTool

All Superinterfaces:
Serializable
All Known Implementing Classes:
GxTool

public interface IGxGPTool
extends Serializable

Provides access to properties/methods of a catalog geoprocessing tool object.

Product Availability

Available with ArcGIS Desktop.


Method Summary
 IGPTool getTool()
          The geoprocessing tool object associated with this catalog geoprocessing tool object.
 void setToolByRef(IGPTool tool)
          The geoprocessing tool object associated with this catalog geoprocessing tool object.
 void updateToolState()
          Updates the icon of the geoprocessing tool displayed in ArcCatalog.
 

Method Detail

getTool

IGPTool getTool()
                throws IOException,
                       AutomationException
The geoprocessing tool object associated with this catalog geoprocessing tool object.

Product Availability

Available with ArcGIS Desktop.

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.

setToolByRef

void setToolByRef(IGPTool tool)
                  throws IOException,
                         AutomationException
The geoprocessing tool object associated with this catalog geoprocessing tool object.

Product Availability

Available with ArcGIS Desktop.

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.

updateToolState

void updateToolState()
                     throws IOException,
                            AutomationException
Updates the icon of the geoprocessing tool displayed in ArcCatalog.

Product Availability

Available with ArcGIS Desktop.

Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.