com.esri.arcgis.addinframework
Interface IRequest

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

IRequestProxy

public interface IRequest
extends java.io.Serializable

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 =

Field Summary

static java.lang.String	IID Deprecated. Internal use only
static int	IIDeaf116c1_68fb_4345_8c1e_d311375e5d54
static int	xxDummy Deprecated. Internal use only

Method Summary

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

Field Detail

IIDeaf116c1_68fb_4345_8c1e_d311375e5d54

static final int IIDeaf116c1_68fb_4345_8c1e_d311375e5d54

See Also:

Constant Field Values

xxDummy

static final int xxDummy

Deprecated. Internal use only

See Also:

Constant Field Values

IID

static final java.lang.String IID

Deprecated. Internal use only

See Also:

Constant Field Values

Method Detail

setData

void setData(int pData)
             throws java.io.IOException,
                    AutomationException

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

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

int getData()
            throws java.io.IOException,
                   AutomationException

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

Returns:

The pData (A COM typedef)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

cancel

void cancel()
            throws java.io.IOException,
                   AutomationException

Cancels the execution of this request.

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

esri_wait

void esri_wait(int timeout)
               throws java.io.IOException,
                      AutomationException

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

Parameters:

timeout - The timeout (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSignal

void setSignal(int rhs1)
               throws java.io.IOException,
                      AutomationException

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

Parameters:

rhs1 - A COM void* (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getActive

void getActive()
               throws java.io.IOException,
                      AutomationException

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCompleted

void getCompleted()
                  throws java.io.IOException,
                         AutomationException

Returns S_OK if request completed, otherwise S_FALSE.

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCanceled

void getCanceled()
                 throws java.io.IOException,
                        AutomationException

Returns S_OK if request was cancelled, otherwise S_FALSE.

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

cancelEx

void cancelEx(int delay)
              throws java.io.IOException,
                     AutomationException

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

Parameters:

delay - The delay (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getWaitHandle

void getWaitHandle()
                   throws java.io.IOException,
                          AutomationException

Returns the wait handle associated with the request (is signaled when the request has completed).

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.