public abstract class

AbstractIssuePickerSearchProvider

extends Object
implements IssuePickerSearchProvider
java.lang.Object
   ↳ com.atlassian.jira.bc.issue.search.AbstractIssuePickerSearchProvider
Known Direct Subclasses

Class Overview

Abstract convienience class with common methods for IssuePickerSearchProviers

Summary

Protected Constructors
AbstractIssuePickerSearchProvider(SearchProvider searchProvider, ConstantsManager constantsManager, LuceneQueryModifier modifier)
Public Methods
IssuePickerResults getResults(JiraServiceContext context, IssuePickerSearchService.IssuePickerParameters issuePickerParams, int maxIssueCount)
Returns a list of issues matching the query string
Protected Methods
abstract String getId()
This returns a simple ID of the results, used mainly for html tag ids
abstract String getLabelKey()
This returns the label key of the results, eg why type of results are they.
abstract SearchRequest getRequest(IssuePickerSearchService.IssuePickerParameters issuePickerParams)
Return the search that this provider uses as its view of all issues.
[Expand]
Inherited Methods
From class java.lang.Object
From interface com.atlassian.jira.bc.issue.search.IssuePickerSearchProvider

Protected Constructors

protected AbstractIssuePickerSearchProvider (SearchProvider searchProvider, ConstantsManager constantsManager, LuceneQueryModifier modifier)

Public Methods

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

Returns a list of issues matching the query string

Parameters
context service context
issuePickerParams params for issue picker
maxIssueCount Number of issues still needed.
Returns
  • list of issues that match query (implementation specific) which is never null.
See Also

Protected Methods

protected abstract String getId ()

This returns a simple ID of the results, used mainly for html tag ids

Returns
  • an i18n key.

protected abstract String getLabelKey ()

This returns the label key of the results, eg why type of results are they.

Returns
  • an i18n key.

protected abstract SearchRequest getRequest (IssuePickerSearchService.IssuePickerParameters issuePickerParams)

Return the search that this provider uses as its view of all issues.

Parameters
issuePickerParams the paramaters from the issue picker.
Returns
  • the search request that returns all issues the provide sees and works with.