Package com.atlassian.confluence.api.model.search

Class SearchPageResponse<T>

  • Type Parameters:
    T - the type of entity in the collection of search results
    All Implemented Interfaces:
    PageResponse<T>, Iterable<T>
    @ExperimentalApi
public class SearchPageResponse<T>
extends Object
implements PageResponse<T>
    A page response impl for the search service which provides the total size of the result set, along with the CQL Query that was used to generate the result set.

    • Method Detail

      • size

        public int size()
        Specified by:
        size in interface PageResponse<T>
        Returns:
        the number of results in this page of results

      • totalSize

        public int totalSize()
        Returns:
        the total size of the requested result set, this equal to or greater than the number of results returned in the page response.

      • getSearchDuration

        public int getSearchDuration()
        Returns:
        search duration in milliseconds

      • getArchivedResultCount

        @Deprecated
public com.atlassian.fugue.Option<Integer> getArchivedResultCount()
        Deprecated.
        since 7.0.1. Use archivedResultCount()
        Returns:
        number of hits from archived spaces. Only shown if the original search returned no results.

      • archivedResultCount

        public Optional<Integer> archivedResultCount()
        Returns:
        number of hits from archived spaces. Only shown if the original search returned no results.
        Since:
        7.0.1

      • hasMore

        public boolean hasMore()
        Description copied from interface: PageResponse
        Indicates whether the source has more results after this page.
        Specified by:
        hasMore in interface PageResponse<T>
        Returns:
        true if there are more results

      • getCqlQuery

        public String getCqlQuery()
        Returns:
        the CQL query used to query this set of results