com.rallydev.rest.response

Class QueryResponse

java.lang.Object

com.rallydev.rest.response.Response

com.rallydev.rest.response.QueryResponse

public class QueryResponse
extends Response

Represents a WSAPI response from querying for objects.

Field Summary

Fields inherited from class com.rallydev.rest.response.Response

raw, result

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
int	getPageSize() Get the page size of the results
com.google.gson.JsonArray	getResults() Get the results of the query
protected String	getRoot() Get the name of the root JSON result
int	getStart() Get the start index of the results
int	getTotalResultCount() Get the total number of objects that matched the query

Methods inherited from class com.rallydev.rest.response.Response

getErrors, getWarnings, wasSuccessful

Methods inherited from class java.lang.Object

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

Constructor Detail

QueryResponse

public QueryResponse(String queryResponse)

Create a new query response from the specified JSON encoded string.

Parameters:

queryResponse - the JSON encoded string

Method Detail

getRoot

protected String getRoot()

Get the name of the root JSON result

Specified by:

getRoot in class Response

Returns:

the root element name

getTotalResultCount

public int getTotalResultCount()

Get the total number of objects that matched the query

Returns:

the total number of objects

getResults

public com.google.gson.JsonArray getResults()

Get the results of the query

Depending on the limit of the original request this may include one or more pages.

Returns:

the results

getPageSize

public int getPageSize()

Get the page size of the results

Returns:

the page size

getStart

public int getStart()

Get the start index of the results

Returns:

the start index