public class

PortalQueryResultSet

extends Object
java.lang.Object
   ↳ com.esri.core.portal.PortalQueryResultSet<T>

Class Overview

A class that contains the results of queries performed on a Portal. A "pageable" search performed on a Portal may yield a large number of results. The number of results in a PortalQueryResultSet is limited by the results limit field of the PortalQueryParams used to make the query. By default, only the first ten result values are returned. The PortalQueryResultSet allows clients to retrieve results in batches. Use getNextQueryParams() to get a PortalQueryParams object to fetch the next batch of results.

Summary

Public Constructors
PortalQueryResultSet(PortalQueryParams queryParams, PortalQueryParams nextQueryParams, int totalResults, List<T> results)
The Constructor.
Public Methods
boolean equals(Object obj)
PortalQueryParams getNextQueryParams()
Returns the parameters for the next query, if any.
PortalQueryParams getQueryParams()
Returns the original query parameters used to generate these results.
List<T> getResults()
Returns the results of the query.
int getTotalResults()
Returns the total number of results generated by the query.
int hashCode()
String toString()
[Expand]
Inherited Methods
From class java.lang.Object

Public Constructors

public PortalQueryResultSet (PortalQueryParams queryParams, PortalQueryParams nextQueryParams, int totalResults, List<T> results)

The Constructor.

Parameters
queryParams PortalQueryParams: the original query parameters used to generate these results
nextQueryParams PortalQueryParams: the parameters for the next query, if any
totalResults int: the total number of results generated by the query
results List: the results of the query

Public Methods

public boolean equals (Object obj)

Parameters
obj Object
Returns
boolean

public PortalQueryParams getNextQueryParams ()

Returns the parameters for the next query, if any.

Returns
PortalQueryParams parameters for the next query, or null if no more results to fetch

public PortalQueryParams getQueryParams ()

Returns the original query parameters used to generate these results.

Returns
PortalQueryParams original query parameters

public List<T> getResults ()

Returns the results of the query. This is limited by the number in the results limit field of the PortalQueryParams used to generate this query.

Returns
List<T> results of the query

public int getTotalResults ()

Returns the total number of results generated by the query.

Returns
int total number of results generated by the query

public int hashCode ()

Returns
int

public String toString ()

Returns
String