|
Eclipse Platform Release 3.3 |
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Common base interface for an asynchronously processed request. A request may succeed,
fail or be canceled as indicated by the request's status. When a request is complete
the client fulfilling the request must call 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 implemented this interface.
Method Summary | |
---|---|
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. |
Method Detail |
public 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
public IStatus getStatus()
null
.
null
is equivalent
to an OK statuspublic void done()
public void cancel()
done()
to indicate the request is complete.
public 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.
|
Eclipse Platform Release 3.3 |
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Guidelines for using Eclipse APIs.
Copyright (c) IBM Corp. and others 2000, 2007. All rights reserved.