com.esri.arcgis.addinframework
Class IRequestProxy

java.lang.Object
  com.esri.arcgis.interop.Dispatch
      com.esri.arcgis.addinframework.IRequestProxy

All Implemented Interfaces:

IRequest, Externalizable, Serializable

public class IRequestProxy
extends com.esri.arcgis.interop.Dispatch
implements IRequest, Serializable

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

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

Method Summary

void	addListener(String iidStr, Object theListener, Object theSource)
void	cancel() Cancels the execution of this request.
void	cancelEx(int delay) Cancels the execution of this request if still running after the specified delay in milliseconds.
void	esri_wait(int timeout) Waits for the request to complete or timeout.
void	getActive() Returns S_OK if request is currently being processed, S_FALSE otherwise.
void	getCanceled() Returns S_OK if request was cancelled, otherwise S_FALSE.
void	getCompleted() Returns S_OK if request completed, otherwise S_FALSE.
int	getData() Gets or sets the user defined data associated with this request.
void	removeListener(String iidStr, Object theListener)
void	setData(int pData) Gets or sets the user defined data associated with this request.
void	setSignal(int rhs1) Specifies an event handle which will be signaled when the request completes or is canceled.

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

IRequestProxy

public IRequestProxy()

IRequestProxy

public IRequestProxy(Object obj)
              throws IOException

Throws:

IOException

IRequestProxy

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

setData

public void setData(int pData)
             throws IOException,
                    AutomationException

Gets or sets the user defined data associated with this request.

Specified by:

setData in interface IRequest

Parameters:

pData - The pData (A COM typedef) (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getData

public int getData()
            throws IOException,
                   AutomationException

Gets or sets the user defined data associated with this request.

Specified by:

getData in interface IRequest

Returns:

The pData (A COM typedef)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

cancel

public void cancel()
            throws IOException,
                   AutomationException

Cancels the execution of this request.

Specified by:

cancel in interface IRequest

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

esri_wait

public void esri_wait(int timeout)
               throws IOException,
                      AutomationException

Waits for the request to complete or timeout. Returns S_FALSE if request timesout.

Specified by:

esri_wait in interface IRequest

Parameters:

timeout - The timeout (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSignal

public void setSignal(int rhs1)
               throws IOException,
                      AutomationException

Specifies an event handle which will be signaled when the request completes or is canceled.

Specified by:

setSignal in interface IRequest

Parameters:

rhs1 - A COM void* (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getActive

public void getActive()
               throws IOException,
                      AutomationException

Returns S_OK if request is currently being processed, S_FALSE otherwise.

Specified by:

getActive in interface IRequest

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCompleted

public void getCompleted()
                  throws IOException,
                         AutomationException

Returns S_OK if request completed, otherwise S_FALSE.

Specified by:

getCompleted in interface IRequest

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCanceled

public void getCanceled()
                 throws IOException,
                        AutomationException

Returns S_OK if request was cancelled, otherwise S_FALSE.

Specified by:

getCanceled in interface IRequest

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

cancelEx

public void cancelEx(int delay)
              throws IOException,
                     AutomationException

Cancels the execution of this request if still running after the specified delay in milliseconds.

Specified by:

cancelEx in interface IRequest

Parameters:

delay - The delay (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.