public interface IRequest
done()
on the request whether
the operation succeeds, fails, or is canceled.
Specific requests (sub types of this interface) often include data pertaining to the request and usually contain results of the request.
Clients are expected to poll a request (using isCanceled
)
periodically and abort at their earliest convenience calling done()
.
A request can be canceled by the originator of the request or a client
fulfilling a request.
Clients that invoke request handlers may implement this interface.
Modifier and Type | Method and Description |
---|---|
void |
cancel()
Cancels this request.
|
void |
done()
Indicates this request is complete.
|
IStatus |
getStatus()
Returns the status of this request, or
null . |
boolean |
isCanceled()
Returns whether this request has been canceled.
|
void |
setStatus(IStatus status)
Sets the status for this request indicating whether this request
succeeded, failed, or was canceled.
|
void setStatus(IStatus status)
null
status is considered
to be successful. Only clients fulfilling a request should call this
method. Clients making a request are not intended to call this method.status
- request status or null
IStatus getStatus()
null
.null
is equivalent
to an OK statusvoid done()
void cancel()
done()
to indicate the request is complete.boolean isCanceled()
Clients fulfilling a request are expected to poll a request (using isCanceled
)
periodically and abort at their earliest convenience calling done()
.
A request can be canceled by the originator of the request or a processor fulfilling a
request.
Copyright (c) 2000, 2015 Eclipse Contributors and others. All rights reserved.Guidelines for using Eclipse APIs.