Interface ContentNameSearchService
-
- All Known Implementing Classes:
DefaultContentNameSearchService
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 Summary
Fields Modifier and Type Field Description static 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.static int
DEFAULT_TOTAL_MAX_RESULTS
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description ContentNameSearchResult
search(String query, ContentNameSearchContext context)
This performs a content name search in Confluence and returns the results.
-
-
-
Field Detail
-
DEFAULT_MAX_RESULTS_PER_CATEGORY
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
-
DEFAULT_TOTAL_MAX_RESULTS
static final int DEFAULT_TOTAL_MAX_RESULTS
- 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.- Parameters:
query
- The text that the user wishes to search for.context
- The search context to be used in order to carry the search request- Returns:
- The search results. Errors are also encapsulated in the returned object, null should NOT be returned.
- Since:
- 6.13.0
-
-