Class PortalQueryResultSet<T>

  • Type Parameters:
    T - The type of Portal object the query will return, either PortalItem or PortalGroup

    public final class PortalQueryResultSet<T>
    extends Object
    Represents 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 PortalQueryParameters 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 getNextQueryParameters() to get a PortalQueryParameters object to fetch the next batch of results.
    Since:
    100.0.0
    • Method Detail

      • getQueryParameters

        public PortalQueryParameters getQueryParameters()
        Gets the original query parameters used to generate these results.
        Returns:
        original query parameters
        Since:
        100.0.0
      • getNextQueryParameters

        public PortalQueryParameters getNextQueryParameters()
        Gets the parameters for the next query, if any.
        Returns:
        parameters for the next query, or null if no more results to fetch
        Since:
        100.0.0
      • getTotalResults

        public int getTotalResults()
        Gets the total number of results generated by the query.
        Returns:
        total number of results generated by the query
        Since:
        100.0.0