com.esri.arcgis.geoprocessing
Class IGeoProcessorEvents3Proxy

java.lang.Object
  com.esri.arcgis.interop.Dispatch
      com.esri.arcgis.geoprocessing.IGeoProcessorEvents3Proxy

All Implemented Interfaces:

IGeoProcessorEvents3, Externalizable, Serializable

public class IGeoProcessorEvents3Proxy
extends com.esri.arcgis.interop.Dispatch
implements IGeoProcessorEvents3, 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.

See Also:

Serialized Form

Field Summary

boolean

noncastable

Fields inherited from class com.esri.arcgis.interop.Dispatch

DISPATCH_METHOD, DISPATCH_PROPERTYGET, DISPATCH_PROPERTYPUT, DISPATCH_PROPERTYPUTREF, objRef

Constructor Summary

	IGeoProcessorEvents3Proxy()
	IGeoProcessorEvents3Proxy(Object obj)
protected	IGeoProcessorEvents3Proxy(Object obj, String iid)

Method Summary

void	addListener(String iidStr, Object theListener, Object theSource)
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.
void	removeListener(String iidStr, Object theListener)

Methods inherited from class com.esri.arcgis.interop.Dispatch

bindUsingMoniker, constructVtblPosTable, convertToNative, cookieForListener, createDispatch, createObjrefMonikerDisplayName, equals, getActiveObject, getActiveObject, getDefaultProperty, getDispatchIdOfName, getLastErrorCode, getMtsObjectContext, getObjRef, getPropertyByName, getPropertyByName, getVtblPos, hashCode, initDispatch, invoke, invokeMethodByName, invokeMethodByName, invokeMethodByName, invokePropertyGetByName, invokePropertyPutByName, invokePropertyPutByRefByName, isNativeMode, isObjRef, optimizedVtblInvoke, queryInterface, readExternal, release, setNativeMode, setPropertyByName, toString, vtblInvoke, writeExternal

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

noncastable

public boolean noncastable

Constructor Detail

IGeoProcessorEvents3Proxy

public IGeoProcessorEvents3Proxy()

IGeoProcessorEvents3Proxy

public IGeoProcessorEvents3Proxy(Object obj)
                          throws IOException

Throws:

IOException

IGeoProcessorEvents3Proxy

protected IGeoProcessorEvents3Proxy(Object obj,
                                    String iid)
                             throws IOException

Throws:

IOException

Method Detail

addListener

public void addListener(String iidStr,
                        Object theListener,
                        Object theSource)
                 throws IOException

Overrides:

addListener in class com.esri.arcgis.interop.Dispatch

Throws:

IOException

removeListener

public void removeListener(String iidStr,
                           Object theListener)
                    throws IOException

Overrides:

removeListener in class com.esri.arcgis.interop.Dispatch

Throws:

IOException

onProgressMessage

public 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.

Specified by:

onProgressMessage in interface IGeoProcessorEvents3

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

public 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.

Specified by:

onProgressShow in interface IGeoProcessorEvents3

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

public 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.

Specified by:

onProgressPercentage in interface IGeoProcessorEvents3

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

public 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.

Specified by:

onProcessMessages in interface IGeoProcessorEvents3

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

public 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.

Specified by:

preToolExecute in interface IGeoProcessorEvents3

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

public 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.

Specified by:

postToolExecute in interface IGeoProcessorEvents3

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.