com.atlassian.confluence.search.contentnames
Class DefaultContentNameSearchService

java.lang.Object
  com.atlassian.confluence.search.contentnames.DefaultContentNameSearchService

All Implemented Interfaces:

ContentNameSearchService

public class DefaultContentNameSearchService
extends java.lang.Object
implements ContentNameSearchService

Field Summary

static java.lang.String

SEARCH_FOR_CSS_CLASS

Fields inherited from interface com.atlassian.confluence.search.contentnames.ContentNameSearchService

DEFAULT_MAX_RESULTS_PER_CATEGORY

Constructor Summary

DefaultContentNameSearchService(SettingsManager settingsManager, I18NBeanFactory i18NBeanFactory, QueryTokenizer contentNameQueryTokenizer, SemaphoreHolder contentNameSearchSemaphoreHolder, com.atlassian.plugin.PluginAccessor pluginAccessor)

Method Summary

ContentNameSearchResult

search(java.lang.String query, java.lang.Iterable<java.lang.String> types, java.lang.String spaceKey, int maxPerCategory, javax.servlet.http.HttpServletRequest httpServletRequest) This performs a content name search in Confluence and returns the results.

Methods inherited from class java.lang.Object

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

Field Detail

SEARCH_FOR_CSS_CLASS

public static final java.lang.String SEARCH_FOR_CSS_CLASS

See Also:

Constant Field Values

Constructor Detail

DefaultContentNameSearchService

public DefaultContentNameSearchService(SettingsManager settingsManager,
                                       I18NBeanFactory i18NBeanFactory,
                                       QueryTokenizer contentNameQueryTokenizer,
                                       SemaphoreHolder contentNameSearchSemaphoreHolder,
                                       com.atlassian.plugin.PluginAccessor pluginAccessor)

Method Detail

search

public ContentNameSearchResult search(java.lang.String query,
                                      java.lang.Iterable<java.lang.String> types,
                                      java.lang.String spaceKey,
                                      int maxPerCategory,
                                      javax.servlet.http.HttpServletRequest httpServletRequest)

Description copied from interface: ContentNameSearchService

This performs a content name search in Confluence and returns the results.

Specified by:

search in interface ContentNameSearchService

Parameters:

query - The text that the user wishes to search for.

types - Uses the default "types" (Search Categories) if nothing is provided, otherwise returns different Categories than the default.

spaceKey - You can restrict your search to a particular space if provided. By default it searches all of Confluence.

maxPerCategory - If maxPerCategory is -1 then it returns the default maximum amount, otherwise it returns the positive number provided.

Returns:

The search results. Errors are also encapsulated in the returned object, null should NOT be returned.