|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.smartgwt.client.core.JsObject
com.smartgwt.client.core.DataClass
com.smartgwt.client.rpc.RPCResponse
public class RPCResponse
Encapsulates an RPC response from the server. Instances of this class are automatically created and optionally passed to you in the callback you specify as part of your RPCRequest.
Field Summary | |
---|---|
static int |
STATUS_FAILURE
|
static int |
STATUS_LOGIN_INCORRECT
|
static int |
STATUS_LOGIN_REQUIRED
|
static int |
STATUS_LOGIN_SUCCESS
|
static int |
STATUS_MAX_LOGIN_ATTEMPTS_EXCEEDED
|
static int |
STATUS_SERVER_TIMEOUT
|
static int |
STATUS_SUCCESS
|
static int |
STATUS_TRANSPORT_ERROR
|
static int |
STATUS_VALIDATION_ERROR
|
Fields inherited from class com.smartgwt.client.core.JsObject |
---|
jsObj |
Constructor Summary | |
---|---|
RPCResponse()
|
|
RPCResponse(com.google.gwt.core.client.JavaScriptObject jsObj)
|
Method Summary | |
---|---|
java.lang.Integer |
getHttpResponseCode()
This attribute (avialable when using the the xmlHttpRequest transport) contains
the HTTP response code sent by the server.
|
static RPCResponse |
getOrCreateRef(com.google.gwt.core.client.JavaScriptObject jsObj)
|
int |
getStatus()
Status code for this response. |
java.lang.Integer |
getTransactionNum()
ID of the transaction sent to the server via RPCManager.sendQueue() containing the
RPCRequest associated with this response. |
void |
setStatus(int status)
Status code for this response. |
Methods inherited from class com.smartgwt.client.core.JsObject |
---|
isCreated, setJsObj |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static int STATUS_FAILURE
public static int STATUS_LOGIN_INCORRECT
public static int STATUS_LOGIN_REQUIRED
public static int STATUS_LOGIN_SUCCESS
public static int STATUS_MAX_LOGIN_ATTEMPTS_EXCEEDED
public static int STATUS_SERVER_TIMEOUT
public static int STATUS_SUCCESS
public static int STATUS_TRANSPORT_ERROR
public static int STATUS_VALIDATION_ERROR
Constructor Detail |
---|
public RPCResponse()
public RPCResponse(com.google.gwt.core.client.JavaScriptObject jsObj)
Method Detail |
---|
public static RPCResponse getOrCreateRef(com.google.gwt.core.client.JavaScriptObject jsObj)
public int getStatus()
RPCManager
for more information on
what the RPCManager does with the status code and how you can override this behavior.
When using the SmartGWT server you can set the rpcResponse.status by calling the server-side method RPCResponse.setStatus().
When not using the SmartGWT server, the RPCManager makes no assumptions about the
structure of the response, so the status code just reflects the
httpResponseCode
: status will be
STATUS_TRANSPORT_ERROR
if an HTTP-level error
occurred such as "500 server error". If you have a status code you need to transmit you can
simply embed it in the response (as part of data
) and interpret it from
the callback.
With or without the SmartGWT server, the Relogin
status codes (such as
STATUS_LOGIN_REQUIRED
) are triggered whenever special markers, such as the
loginRequiredMarker, appear in the body of the response. See the 'Relogin
Overview'
for details.
public java.lang.Integer getHttpResponseCode()
xmlHttpRequest
transport) contains
the HTTP response code sent by the server.
Note that this is different from status
- that attribute is used to
indicate a status code for the RPC itself whereas httpResponseCode is the raw HTTP response
code for the HTTP request that contained the RPCRequest.
This feature relies on the XMLHttpRequest object which can be disabled by end-users in some
supported browsers. See PlatformDependencies
for more information.
If you're using this attribute, you'll typically want to avoid the default error
handling response of RPCManager. To do so, set
willHandleError
to true
.
public java.lang.Integer getTransactionNum()
RPCManager.sendQueue()
containing the
RPCRequest
associated with this response.
public void setStatus(int status)
RPCManager
for more information on what the RPCManager does with the status code and how
you can override this behavior. When using the SmartGWT server you can set the rpcResponse.status by calling the server-side method RPCResponse.setStatus().
When not using the SmartGWT server, the
RPCManager makes no assumptions about the structure of the response, so the status code just reflects the httpResponseCode
: status will be STATUS_TRANSPORT_ERROR
if an HTTP-level error occurred such as "500 server
error". If you have a status code you need to transmit you can simply embed it in the response (as part of
data
) and interpret it from the callback.
With or without the SmartGWT server, the Relogin Overview for details.
status
- status
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |