com.atlassian.confluence.plugins.quicknav.admin

Class AdminItemSearchSectionProvider

java.lang.Object

com.atlassian.confluence.plugins.quicknav.admin.AdminItemSearchSectionProvider

All Implemented Interfaces:

ContentNameSearchSectionsProvider

public class AdminItemSearchSectionProvider
extends Object
implements ContentNameSearchSectionsProvider

Section provider for quick nav that includes admin items in the results. On each request we search through all available admin items for the current user and filter out the ones whose label matches with the query tokens.

Constructor Summary

Constructors

Constructor and Description
AdminItemSearchSectionProvider()

Method Summary

Modifier and Type	Method and Description
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.
List<ContentNameMatch>	searchAdminItems(List<QueryToken> queryTokens) Finds all admin web items that match the given query and returns them in as a list of ContentNameMatchs to be consumed by ContentNameSearchAction.
void	setPermissionManager(PermissionManager permissionManager)
void	setWebInterfaceManager(com.atlassian.plugin.web.WebInterfaceManager webInterfaceManager)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AdminItemSearchSectionProvider

public AdminItemSearchSectionProvider()

Method Detail

getSections

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

Description copied from interface: ContentNameSearchSectionsProvider

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

Specified by:

getSections in interface ContentNameSearchSectionsProvider

Parameters:

queryTokens - the query as tokenized by Confluence

Returns:

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

searchAdminItems

public List<ContentNameMatch> searchAdminItems(List<QueryToken> queryTokens)

Finds all admin web items that match the given query and returns them in as a list of ContentNameMatchs to be consumed by ContentNameSearchAction.

Parameters:

queryTokens -

Returns:

setWebInterfaceManager

public void setWebInterfaceManager(com.atlassian.plugin.web.WebInterfaceManager webInterfaceManager)

setPermissionManager

public void setPermissionManager(PermissionManager permissionManager)