com.esri.arcgis.geoprocessing
Interface IGeoProcessorEvents3

All Superinterfaces:

Serializable

All Known Implementing Classes:

IGeoProcessorEvents3Proxy

public interface IGeoProcessorEvents3
extends Serializable

Provides access to GeoProcessor events3.

Description

This interface is new at ArcGIS 10. Events are fired in response to calling both the IGeoprocessor2.Execute method and the IGeoProcessor2.ExecuteASync method.

Product Availability

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

Method Summary

void	onProcessMessages(IGeoProcessorResult result, IGPMessages pMsgs) Called when a message has been posted while executing a tool.
void	onProgressMessage(IGeoProcessorResult result, String message) Called when a message has been posted while executing a tool.
void	onProgressPercentage(IGeoProcessorResult result, double percentage) Called when a message has been posted while executing a tool.
void	onProgressShow(IGeoProcessorResult result, boolean show) Called when a message has been posted while executing a tool.
void	postToolExecute(IGeoProcessorResult result) Called immediately after a tool is executed by the GeoProcessor.
void	preToolExecute(IGeoProcessorResult result) Called immediately prior to the GeoProcessor executing a tool.

Method Detail

onProgressMessage

void onProgressMessage(IGeoProcessorResult result,
                       String message)
                       throws IOException,
                              AutomationException

Called when a message has been posted while executing a tool.

Product Availability

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

Parameters:

result - A reference to a com.esri.arcgis.geoprocessing.IGeoProcessorResult (in)

message - The message (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

onProgressShow

void onProgressShow(IGeoProcessorResult result,
                    boolean show)
                    throws IOException,
                           AutomationException

Called when a message has been posted while executing a tool.

Product Availability

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

Parameters:

result - A reference to a com.esri.arcgis.geoprocessing.IGeoProcessorResult (in)

show - The show (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

onProgressPercentage

void onProgressPercentage(IGeoProcessorResult result,
                          double percentage)
                          throws IOException,
                                 AutomationException

Called when a message has been posted while executing a tool.

Product Availability

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

Parameters:

result - A reference to a com.esri.arcgis.geoprocessing.IGeoProcessorResult (in)

percentage - The percentage (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

onProcessMessages

void onProcessMessages(IGeoProcessorResult result,
                       IGPMessages pMsgs)
                       throws IOException,
                              AutomationException

Called when a message has been posted while executing a tool.

Product Availability

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

Parameters:

result - A reference to a com.esri.arcgis.geoprocessing.IGeoProcessorResult (in)

pMsgs - A reference to a com.esri.arcgis.geodatabase.IGPMessages (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

preToolExecute

void preToolExecute(IGeoProcessorResult result)
                    throws IOException,
                           AutomationException

Called immediately prior to the GeoProcessor executing a tool.

Product Availability

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

Parameters:

result - A reference to a com.esri.arcgis.geoprocessing.IGeoProcessorResult (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

postToolExecute

void postToolExecute(IGeoProcessorResult result)
                     throws IOException,
                            AutomationException

Called immediately after a tool is executed by the GeoProcessor.

Product Availability

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

Parameters:

result - A reference to a com.esri.arcgis.geoprocessing.IGeoProcessorResult (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.