com.atlassian.confluence.search.contentnames
Interface ContentNameSearchSectionsProvider
- All Known Implementing Classes:
- 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.
getSections
java.util.Collection<ContentNameSearchSection> getSections(java.util.List<QueryToken> queryTokens,
ContentNameSearchContext context)
- For the given query tokens the method should return a collection of
ContentNameSearchSection
s that in
some way match the query.
- Parameters:
queryTokens
- the query as tokenized by Confluencecontext
-
- Returns:
- the
ContentNameSearchSection
s to be included in the quick nav result or null if nothing should be
included
Copyright © 2003-2014 Atlassian. All Rights Reserved.