com.atlassian.jira.bc.issue.search

Interface IssuePickerSearchProvider

All Known Implementing Classes:

AbstractIssuePickerSearchProvider, HistoryIssuePickerSearchProvider, LuceneCurrentSearchIssuePickerSearchProvider

public interface IssuePickerSearchProvider

Interface used by DefaultIssuePickerSearchService to retrieve issue matches.

Method Summary

Modifier and Type	Method and Description
IssuePickerResults	getResults(JiraServiceContext context, IssuePickerSearchService.IssuePickerParameters issuePickerParams, int issueRemaining) Returns a list of issues matching the query string
boolean	handlesParameters(ApplicationUser searcher, IssuePickerSearchService.IssuePickerParameters issuePickerParams) Indicates to the caller whether or not this provider can handle the passed parameters.

Method Detail

getResults

IssuePickerResults getResults(JiraServiceContext context,
                              IssuePickerSearchService.IssuePickerParameters issuePickerParams,
                              int issueRemaining)

Returns a list of issues matching the query string

Parameters:

context - service context

issuePickerParams - params for issue picker

issueRemaining - Number of issues still needed.

Returns:

list of issues that match query (implementation specific) which is never null.

handlesParameters

boolean handlesParameters(ApplicationUser searcher,
                          IssuePickerSearchService.IssuePickerParameters issuePickerParams)

Indicates to the caller whether or not this provider can handle the passed parameters.

Parameters:

searcher - the user performing the search.

issuePickerParams - the parameters to check.

Returns:

true if the provider can handle the passed parameters false otherwise.