com.atlassian.jira.bc.issue.search
Class AbstractIssuePickerSearchProvider

java.lang.Object
  com.atlassian.jira.bc.issue.search.AbstractIssuePickerSearchProvider

All Implemented Interfaces:

IssuePickerSearchProvider

Direct Known Subclasses:

HistoryIssuePickerSearchProvider, LuceneCurrentSearchIssuePickerSearchProvider

public abstract class AbstractIssuePickerSearchProvider
extends Object
implements IssuePickerSearchProvider

Abstract convienience class with common methods for IssuePickerSearchProviers

Constructor Summary

protected

AbstractIssuePickerSearchProvider(SearchProvider searchProvider, ConstantsManager constantsManager, LuceneQueryModifier modifier)

Method Summary

protected abstract String	getId() This returns a simple ID of the results, used mainly for html tag ids
protected abstract String	getLabelKey() This returns the label key of the results, eg why type of results are they.
protected abstract SearchRequest	getRequest(IssuePickerSearchService.IssuePickerParameters issuePickerParams) Return the search that this provider uses as its view of all issues.
IssuePickerResults	getResults(JiraServiceContext context, IssuePickerSearchService.IssuePickerParameters issuePickerParams, int maxIssueCount) Returns a list of issues matching the query string

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.atlassian.jira.bc.issue.search.IssuePickerSearchProvider

handlesParameters

Constructor Detail

AbstractIssuePickerSearchProvider

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

Method Detail

getResults

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

Description copied from interface: IssuePickerSearchProvider

Returns a list of issues matching the query string

Specified by:

getResults in interface IssuePickerSearchProvider

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:

IssuePickerSearchProvider

getLabelKey

protected abstract String getLabelKey()

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

Returns:

an i18n key.

getId

protected abstract String getId()

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

Returns:

an i18n key.

getRequest

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.