com.esri.arcgis.addinframework
Class IRequestProxy

java.lang.Object
  extended by com.esri.arcgis.interop.Dispatch
      extended by com.esri.arcgis.addinframework.IRequestProxy
All Implemented Interfaces:
IRequest, java.io.Externalizable, java.io.Serializable

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

Internal use class Proxy for COM Interface 'IRequest'. Generated 3/19/2015 1:21:02 PM from 'C:\ArcGIS\SharedArcGIS\DepFiles\com\DADF\esriDADFSystem.tlb'

Generator Options: PromptForTypeLibraries = False ClashPrefix = esri_ LowerCaseMemberNames = True IDispatchOnly = False RetryOnReject = False AwtForOcxs = True ArraysAsObjects = False DontRenameSameMethods = False ImplementConflictingInterfaces = True ReuseMethods = True RenameConflictingInterfaceMethods = True GenBeanInfo = True GenerateJavadoc =

See Also:
Serialized Form

Field Summary
 boolean noncastable
           
static java.lang.Class targetClass
           
 
Fields inherited from class com.esri.arcgis.interop.Dispatch
DISPATCH_METHOD, DISPATCH_PROPERTYGET, DISPATCH_PROPERTYPUT, DISPATCH_PROPERTYPUTREF, objRef
 
Fields inherited from interface com.esri.arcgis.addinframework.IRequest
IID, IIDeaf116c1_68fb_4345_8c1e_d311375e5d54
 
Constructor Summary
  IRequestProxy()
          For internal use only
  IRequestProxy(java.lang.Object obj)
           
protected IRequestProxy(java.lang.Object obj, java.lang.String iid)
           
  IRequestProxy(java.lang.String CLSID, java.lang.String host, com.esri.arcgis.interop.AuthInfo authInfo)
           
protected IRequestProxy(java.lang.String CLSID, java.lang.String iid, java.lang.String host, com.esri.arcgis.interop.AuthInfo authInfo)
           
 
Method Summary
 void addListener(java.lang.String iidStr, java.lang.Object theListener, java.lang.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 getWaitHandle()
          Returns the wait handle associated with the request (is signaled when the request has completed).
 void removeListener(java.lang.String iidStr, java.lang.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

targetClass

public static final java.lang.Class targetClass

noncastable

public boolean noncastable
Constructor Detail

IRequestProxy

public IRequestProxy(java.lang.String CLSID,
                     java.lang.String host,
                     com.esri.arcgis.interop.AuthInfo authInfo)
              throws java.net.UnknownHostException,
                     java.io.IOException
Throws:
java.net.UnknownHostException
java.io.IOException

IRequestProxy

public IRequestProxy()
For internal use only


IRequestProxy

public IRequestProxy(java.lang.Object obj)
              throws java.io.IOException
Throws:
java.io.IOException

IRequestProxy

protected IRequestProxy(java.lang.Object obj,
                        java.lang.String iid)
                 throws java.io.IOException
Throws:
java.io.IOException

IRequestProxy

protected IRequestProxy(java.lang.String CLSID,
                        java.lang.String iid,
                        java.lang.String host,
                        com.esri.arcgis.interop.AuthInfo authInfo)
                 throws java.io.IOException
Throws:
java.io.IOException
Method Detail

addListener

public void addListener(java.lang.String iidStr,
                        java.lang.Object theListener,
                        java.lang.Object theSource)
                 throws java.io.IOException
Overrides:
addListener in class com.esri.arcgis.interop.Dispatch
Throws:
java.io.IOException

removeListener

public void removeListener(java.lang.String iidStr,
                           java.lang.Object theListener)
                    throws java.io.IOException
Overrides:
removeListener in class com.esri.arcgis.interop.Dispatch
Throws:
java.io.IOException

setData

public void setData(int pData)
             throws java.io.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:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getData

public int getData()
            throws java.io.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:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

cancel

public void cancel()
            throws java.io.IOException,
                   AutomationException
Cancels the execution of this request.

Specified by:
cancel in interface IRequest
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

esri_wait

public void esri_wait(int timeout)
               throws java.io.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:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setSignal

public void setSignal(int rhs1)
               throws java.io.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:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getActive

public void getActive()
               throws java.io.IOException,
                      AutomationException
Returns S_OK if request is currently being processed, S_FALSE otherwise.

Specified by:
getActive in interface IRequest
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getCompleted

public void getCompleted()
                  throws java.io.IOException,
                         AutomationException
Returns S_OK if request completed, otherwise S_FALSE.

Specified by:
getCompleted in interface IRequest
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getCanceled

public void getCanceled()
                 throws java.io.IOException,
                        AutomationException
Returns S_OK if request was cancelled, otherwise S_FALSE.

Specified by:
getCanceled in interface IRequest
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

cancelEx

public void cancelEx(int delay)
              throws java.io.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:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getWaitHandle

public void getWaitHandle()
                   throws java.io.IOException,
                          AutomationException
Returns the wait handle associated with the request (is signaled when the request has completed).

Specified by:
getWaitHandle in interface IRequest
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.