Package com.atlassian.confluence.search.v2

Class CustomSearch

  • All Implemented Interfaces:
    ISearch
    @Deprecated(since="8.7.0",
            forRemoval=true)
public class CustomSearch
extends AbstractSearch
    Deprecated, for removal: This API element is subject to removal in a future version.
    since 8.7.0
    Represents a search against custom index. Please should use DefaultSearch instead
    Since:
    7.17

    • Constructor Detail

      • CustomSearch

        public CustomSearch​(@NonNull SearchQuery query,
                    SearchSort sort)
        Deprecated, for removal: This API element is subject to removal in a future version.
        Constructs a search against custom indexes. The maximum number of results returned will be a system provided default.
        Parameters:
        query - the non-null query to perform against custom index
        sort - how to order the results of the query
        Since:
        7.20

      • CustomSearch

        public CustomSearch​(@NonNull SearchQuery query,
                    SearchSort sort,
                    int startOffset,
                    int limit)
        Deprecated, for removal: This API element is subject to removal in a future version.
        Constructs a search against custom indexes.
        Parameters:
        query - the non-null query to perform against custom index
        sort - how to order the results of the query
        startOffset - the zero-based offset of the first content result to return
        limit - the maximum number content results to return
        Since:
        7.20

      • CustomSearch

        public CustomSearch​(List<Index> indices,
                    @NonNull SearchQuery query,
                    SearchSort sort,
                    int startOffset,
                    int limit)
        Deprecated, for removal: This API element is subject to removal in a future version.
        Since:
        8.7.0

      • CustomSearch

        public CustomSearch​(List<Index> indices,
                    @NonNull SearchQuery query,
                    SearchSort sort,
                    int startOffset,
                    int limit,
                    List<String> searchAfter)
        Deprecated, for removal: This API element is subject to removal in a future version.
        Since:
        8.7.0

    • Method Detail

      • withSearchAfter

        public ISearch withSearchAfter​(List<String> searchAfter)
        Deprecated, for removal: This API element is subject to removal in a future version.
        Description copied from interface: ISearch
        This method is only relevant to OpenSearch. A class must implement this method. Otherwise, it will have no effect on the search results.
        Parameters:
        searchAfter - the searchAfter parameter
        Returns:
        a new ISearch containing the searchAfter parameter
        Since:
        8.7.0

      • withIndices

        public ISearch withIndices​(List<Index> indices)
        Deprecated, for removal: This API element is subject to removal in a future version.
        Description copied from interface: ISearch
        This method is only applicable for CustomSearch and DefaultSearch A class must implement this method. Otherwise, it will have no effect on the search results.
        Parameters:
        indices - the indices to search from
        Returns:
        a new ISearch containing the new indices
        Since:
        8.7.0

      • withQuery

        public ISearch withQuery​(SearchQuery query)
        Deprecated, for removal: This API element is subject to removal in a future version.
        Description copied from interface: ISearch
        A class must implement this method. Otherwise, UnsupportedOperationException will be thrown.
        Parameters:
        query - the query to be added to the search object
        Returns:
        a new ISearch containing the new query
        Since:
        8.7.0