Package com.esri.arcgisruntime.portal

Class PortalGroupContentSearchResultSet

java.lang.Object

com.esri.arcgisruntime.portal.PortalGroupContentSearchResultSet

public final class PortalGroupContentSearchResultSet
extends Object

Represents the results of a Group Content Search operation performed on a PortalGroup.

A "pageable" search may yield a large number of results. The number of results in a PortalGroupContentSearchResultSet is limited by the results limit field of the PortalGroupContentSearchParameters used to make the search. By default, only the first ten result values are returned. The PortalGroupContentSearchResultSet allows clients to retrieve results in batches. Use getNextSearchParameters() to get a PortalGroupContentSearchParameters object to fetch the next batch of results.

Since:

100.7.0

See Also:

PortalGroup.findItemsAsync(PortalGroupContentSearchParameters)

Method Summary

Modifier and Type	Method	Description
PortalGroupContentSearchParameters	getNextSearchParameters()	Gets the search parameters that can be used to fetch the next set of results.
List<PortalItem>	getResults()	Gets the present results of the search.
PortalGroupContentSearchParameters	getSearchParameters()	Gets the search parameters used to generate these results.
int	getTotalResults()	Gets the total number of results irrespective of the paging.

Methods inherited from class java.lang.Object

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

Method Detail

getNextSearchParameters

public PortalGroupContentSearchParameters getNextSearchParameters()

Gets the search parameters that can be used to fetch the next set of results.

This is automatically generated if there are more results to be retrieved, or it will be null if no more items are available. Pass it to a further call to PortalGroup.findItemsAsync(PortalGroupContentSearchParameters) to fetch the next set of results.

Returns:

the parameters for the next search, or null if there are no more results to fetch

Since:

100.7.0

getResults

public List<PortalItem> getResults()

Gets the present results of the search. These are limited by the value of PortalGroupContentSearchParameters.getLimit() in the parameters used to generate these results.

Returns:

the present results of the search

Since:

100.7.0

getSearchParameters

public PortalGroupContentSearchParameters getSearchParameters()

Gets the search parameters used to generate these results.

Returns:

the search parameters used to generate these results

Since:

100.7.0

getTotalResults

public int getTotalResults()

Gets the total number of results irrespective of the paging.

Returns:

the total number of results

Since:

100.7.0