com.esri.arcgis.addinframework
Interface IRequest

All Superinterfaces:

Serializable

All Known Implementing Classes:

IRequestProxy

public interface IRequest
extends Serializable

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

Method Detail

setData

void setData(int pData)
             throws IOException,
                    AutomationException

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

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getData

int getData()
            throws IOException,
                   AutomationException

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

Returns:

The pData (A COM typedef)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

cancel

void cancel()
            throws IOException,
                   AutomationException

Cancels the execution of this request.

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

esri_wait

void esri_wait(int timeout)
               throws IOException,
                      AutomationException

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

Parameters:

timeout - The timeout (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSignal

void setSignal(int rhs1)
               throws IOException,
                      AutomationException

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

Parameters:

rhs1 - A COM void* (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getActive

void getActive()
               throws IOException,
                      AutomationException

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCompleted

void getCompleted()
                  throws IOException,
                         AutomationException

Returns S_OK if request completed, otherwise S_FALSE.

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCanceled

void getCanceled()
                 throws IOException,
                        AutomationException

Returns S_OK if request was cancelled, otherwise S_FALSE.

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

cancelEx

void cancelEx(int delay)
              throws IOException,
                     AutomationException

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

Parameters:

delay - The delay (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.