com.atlassian.sal.bamboo.search
Class BambooSearchProvider

java.lang.Object
  com.atlassian.sal.bamboo.search.BambooSearchProvider

All Implemented Interfaces:

SearchProvider

public class BambooSearchProvider
extends Object
implements SearchProvider

Search is not currently available in Bamboo so this is stubbed out.

Constructor Summary

BambooSearchProvider()

Method Summary

SearchResults

search(String username, String searchQuery) Runs the a search given a query and returns a searchResult.

Methods inherited from class java.lang.Object

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

Constructor Detail

BambooSearchProvider

public BambooSearchProvider()

Method Detail

search

public SearchResults search(String username,
                            String searchQuery)

Description copied from interface: SearchProvider

Runs the a search given a query and returns a searchResult. The query will return as many hits as the underlying application would return by default.

The searchQuery should be URLencoded, as it may contain parameters as well. For example if a search should only return a maximum number of hits the searchQuery would be '&maxHits=20'

Specified by:

search in interface SearchProvider

Parameters:

username - The user to run the search as. May be null for anonymous searches.

searchQuery - The query to run

Returns:

A SearchResults object