com.esri.arcgis.geoprocessing
Class IGeoProcessorEventsProxy

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

All Implemented Interfaces:

IGeoProcessorEvents, Externalizable, Serializable

public class IGeoProcessorEventsProxy
extends com.esri.arcgis.interop.Dispatch
implements IGeoProcessorEvents, Serializable

Provides access to GeoProcessor events.

Superseded By

IGeoProcessorEvents2

Remarks

The IGeoProcessorEvents interface is not supported in VB6.

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

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

Method Summary

void	addListener(String iidStr, Object theListener, Object theSource)
void	onMessageAdded(IGPMessage message) Called when a message has been posted while executing a tool.
void	postToolExecute(IGPTool tool, IArray values, long result, IGPMessages messages) Called immediately after a tool is executed by the GeoProcessor.
void	preToolExecute(IGPTool tool, IArray values, int processID) Called immediately prior to the GeoProcessor executing a tool.
void	removeListener(String iidStr, Object theListener)
void	toolboxChange() Called when a toolbox is added or removed from the GeoProcessor.

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

IGeoProcessorEventsProxy

public IGeoProcessorEventsProxy()

IGeoProcessorEventsProxy

public IGeoProcessorEventsProxy(Object obj)
                         throws IOException

Throws:

IOException

IGeoProcessorEventsProxy

protected IGeoProcessorEventsProxy(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

onMessageAdded

public void onMessageAdded(IGPMessage 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.

Supported Platforms

Windows

Specified by:

onMessageAdded in interface IGeoProcessorEvents

Parameters:

message - A reference to a com.esri.arcgis.geodatabase.IGPMessage (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

preToolExecute

public void preToolExecute(IGPTool tool,
                           IArray values,
                           int processID)
                    throws IOException,
                           AutomationException

Called immediately prior to the GeoProcessor executing a tool.

Product Availability

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

Supported Platforms

Windows

Specified by:

preToolExecute in interface IGeoProcessorEvents

Parameters:

tool - A reference to a com.esri.arcgis.geoprocessing.IGPTool (in)

values - A reference to a com.esri.arcgis.system.IArray (in)

processID - The processID (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

postToolExecute

public void postToolExecute(IGPTool tool,
                            IArray values,
                            long result,
                            IGPMessages messages)
                     throws IOException,
                            AutomationException

Called immediately after a tool is executed by the GeoProcessor.

Product Availability

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

Supported Platforms

Windows

Specified by:

postToolExecute in interface IGeoProcessorEvents

Parameters:

tool - A reference to a com.esri.arcgis.geoprocessing.IGPTool (in)

values - A reference to a com.esri.arcgis.system.IArray (in)

result - An error code (in)

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

toolboxChange

public void toolboxChange()
                   throws IOException,
                          AutomationException

Called when a toolbox is added or removed from the GeoProcessor.

Product Availability

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

Supported Platforms

Windows

Specified by:

toolboxChange in interface IGeoProcessorEvents

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.