public class RPCResponse
RPCManager
, RPCRequest
, JSTranslater
Modifier and Type | Field and Description |
---|---|
static int | STATUS_FAILURE Indicates a failure of some sort (generic). |
static int | STATUS_SUCCESS Indicates successful completion of the request. |
Constructor and Description |
---|
RPCResponse() Creates an empty RPCResponse. |
RPCResponse(java.lang.Object data) Creates an RPCResponse with the provided data payload. Note: the status of this response is automatically set to the success code (RPCResponse.STATUS_SUCCESS) |
Modifier and Type | Method and Description |
---|---|
java.lang.Object | getData() Retrives the data previosly set via setData() or the constructor that takes the data argument. |
int | getStatus() Retrieves the currently set status code for this response. |
RPCResponse | setData(java.lang.Object data) Sets the response payload to be delivered to the client. |
RPCResponse | setStatus(int status) Sets the status of this response. |
public static final int STATUS_SUCCESS
public static final int STATUS_FAILURE
See the error handling doc section in RPCManager for information on how the client handles errors.
public RPCResponse()
Note: the status of this response is automatically set to the success code (RPCResponse.STATUS_SUCCESS); response is set to a success code (0)
data
- the data you wish to send back.public RPCResponse(java.lang.Object data)
data
- the data you wish to send back.RPCResponse.setData(Object)
public java.lang.Object getData()
public RPCResponse setData(java.lang.Object data)
The object passed to setData() is translated to JavaScript via the JSTranslater class. Virtually anything passed to setData() will make it back to the browser in some reasonable representation; see JSTranslater for full documentation.
You may call setData() any number of times, only the last provided value will be the value sent to the client.
data
- the data you wish to send back.JSTranslater.toJS(Object, Writer)
, JSONFilter
public RPCResponse setStatus(int status)
Negative values will trigger error handling code on the client side - see the client-side reference for RPCManager.handleError(), rpcRequest.willHandleError.
The default client-side behavior for a negative status code is that, if the data sent back (via setData()) is a String, it will be shown to the user in a warning dialog.
status
- the status code for this responsepublic int getStatus()