doc.com.rallydev.rest.response.QueryResponse.html Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of rally-rest-api Show documentation

A java toolkit for interacting with the Rally Rest API

The newest version!






QueryResponse (Rally Rest API for Java 2.2)













Overview
Package
Class
Use
Tree
Deprecated
Index
Help




Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Field | 
Constr | 
Method


Detail: 
Field | 
Constr | 
Method








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.











Constructor Summary

Constructors 

Constructor and Description


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










Method Summary

Methods 

Modifier and Type
Method and Description


int
getPageSize()
Get the page size of the results



JsonArray
getResults()
Get the results of the query



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
equals, 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





getTotalResultCount
public int getTotalResultCount()
Get the total number of objects that matched the query
Returns:
the total number of objects







getResults
public 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
















Overview
Package
Class
Use
Tree
Deprecated
Index
Help




Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Field | 
Constr | 
Method


Detail: 
Field | 
Constr | 
Method

Modifier and Type	Method and Description
`int`	`getPageSize()` Get the page size of the results
`JsonArray`	`getResults()` Get the results of the query
`int`	`getStart()` Get the start index of the results
`int`	`getTotalResultCount()` Get the total number of objects that matched the query