com.esri.core.portal
Class PortalQueryResultSet<T>

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

Type Parameters:

T - The type of Portal object the query will return. i.e., PortalItem or PortalGroup

public class PortalQueryResultSet<T>
extends Object

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. By default, only the first ten result values are returned. The PortalQueryResultSet allows clients to retrieve results in batches and fetches more results from the server when necessary.

Since:

1.0

Constructor Summary

PortalQueryResultSet(PortalQueryParams queryParams, PortalQueryParams nextQueryParams, int totalResults, List<T> results)
The Constructor.

Method Summary

boolean	equals(Object obj)
PortalQueryParams	getNextQueryParams() Returns the next query parameters, 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()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

PortalQueryResultSet

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

The Constructor.

Parameters:

queryParams - the query params

nextQueryParams - the next query params

totalResults - the total results

results - the results

Since:

1.0

Method Detail

getQueryParams

public PortalQueryParams getQueryParams()

Returns the original query parameters used to generate these results.

Returns:

The original query parameters

Since:

1.0

getNextQueryParams

public PortalQueryParams getNextQueryParams()

Returns the next query parameters, if any. If this returns null, it means there were no more results to fetch.

Returns:

The next query parameters

Since:

1.0

getTotalResults

public int getTotalResults()

Returns the total number of results generated by the query.

Returns:

The total number of results generated by the query

Since:

1.0

getResults

public List<T> getResults()

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

Returns:

The results of the query

See Also:

PortalQueryParams.getLimit(), PortalQueryParams.setLimit(int)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object