Interface ContentNameSearchService

  • All Known Implementing Classes:

    public interface ContentNameSearchService

    An search service that will take a query String and apply it as a search across the 'universal title' field within the Confluence search index.

    • Field Detail


        static final int DEFAULT_MAX_RESULTS_PER_CATEGORY
        This can be passed into maxPerCategory to indicate that you wish to get the default number of results back from Confluence.
        See Also:
        Constant Field Values
    • Method Detail

      • search

        ContentNameSearchResult search​(String query,
                                       ContentNameSearchContext context)
        This performs a content name search in Confluence and returns the results.
        query - The text that the user wishes to search for.
        context - The search context to be used in order to carry the search request
        The search results. Errors are also encapsulated in the returned object, null should NOT be returned.