Package com.atlassian.confluence.search.contentnames

Interface ContentNameSearchSectionsProvider

All Known Implementing Classes:

AdminItemSearchSectionProvider, DefaultContentNameSearchSectionsProvider

public interface ContentNameSearchSectionsProvider

This interface must be implemented by plugins who wish to include results in the Confluence quick nav.

For each search request getSections(java.util.List, ContentNameSearchContext) is being called and the results are used populate the quick nav.

Method Summary

Modifier and Type	Method	Description
@Nullable Collection<ContentNameSearchSection>	getSections(List<QueryToken> queryTokens, ContentNameSearchContext context)	For the given query tokens the method should return a collection of ContentNameSearchSections that in some way match the query.

Method Detail

getSections

@Nullable Collection<ContentNameSearchSection> getSections(List<QueryToken> queryTokens,
                                                           ContentNameSearchContext context)

For the given query tokens the method should return a collection of ContentNameSearchSections that in some way match the query.

Parameters:

queryTokens - the query as tokenized by Confluence

context -

Returns:

the ContentNameSearchSections to be included in the quick nav result or null if nothing should be included