com.esri.arcgis.geodatabase
Class ICancelOperationProxy

java.lang.Object
  com.esri.arcgis.interop.Dispatch
      com.esri.arcgis.geodatabase.ICancelOperationProxy

All Implemented Interfaces:

ICancelOperation, Externalizable, Serializable

public class ICancelOperationProxy
extends com.esri.arcgis.interop.Dispatch
implements ICancelOperation, Serializable

Provides access to members that indicate if an operation has been cancelled.

Description

ICancelOperation can be implemented by custom classes in order to provide cancellation functionality to long operations, particularly those on the IFeatureConstruction interface. Several methods on that interface accept an ICancelOperation parameter (which is often left null); if a custom class that implements this interface is passed in as that parameter, changes to that class which modify the return value of the IsCancelled property to True will allow the operations to be cancelled (with an error being raised by the operation).

Remarks

Passing an object that implements this interface to a long operation is only useful in a multithreaded application. Calls to long operations, such as those defined by IFeatureConstruction, are blocking and a different thread is required to trigger the cancel operation on the custom object.

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

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

Method Summary

void	addListener(String iidStr, Object theListener, Object theSource)
boolean	isCancelled() Indicates if the operation has been cancelled.
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

ICancelOperationProxy

public ICancelOperationProxy()

ICancelOperationProxy

public ICancelOperationProxy(Object obj)
                      throws IOException

Throws:

IOException

ICancelOperationProxy

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

isCancelled

public boolean isCancelled()
                    throws IOException,
                           AutomationException

Indicates if the operation has been cancelled.

Description

Returns whether or not the operation is cancelled.

Product Availability

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

Specified by:

isCancelled in interface ICancelOperation

Returns:

The isCancelled

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.