com.rallydev.rest.response

Class Response

java.lang.Object

com.rallydev.rest.response.Response

Direct Known Subclasses:

CollectionUpdateResponse, CreateResponse, DeleteResponse, GetResponse, QueryResponse, UpdateResponse

public abstract class Response
extends Object

Represents a WSAPI response.

Field Summary

Fields

Modifier and Type	Field and Description
protected String	raw
protected com.google.gson.JsonObject	result

Constructor Summary

Constructors

Constructor and Description
Response(String response) Create a new response from the specified JSON encoded string.

Method Summary

Modifier and Type	Method and Description
String[]	getErrors() Get any errors returned in the response.
protected abstract String	getRoot() Get the name of the root JSON result
String[]	getWarnings() Get any warnings returned in the response.
boolean	wasSuccessful() Returns whether the response was successful (no errors)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

result

protected com.google.gson.JsonObject result

raw

protected String raw

Constructor Detail

Response

public Response(String response)

Create a new response from the specified JSON encoded string.

Parameters:

response - the JSON encoded string

Method Detail

wasSuccessful

public boolean wasSuccessful()

Returns whether the response was successful (no errors)

Returns:

whether the response was successful

getErrors

public String[] getErrors()

Get any errors returned in the response.

Returns:

the response errors

getWarnings

public String[] getWarnings()

Get any warnings returned in the response.

Returns:

the response warnings

getRoot

protected abstract String getRoot()

Get the name of the root JSON result

Returns:

the root element name