@PublicApi public interface

IssuePickerSearchService

com.atlassian.jira.bc.issue.search.IssuePickerSearchService
Known Indirect Subclasses

@PublicApi

This interface is designed for plugins to consume (call its methods).

Clients of @PublicApi can expect that programs compiled against a given version will remain binary compatible with later versions of the @PublicApi as per each product's API policy as long as the client does not implement/extend @PublicApi interfaces or classes (refer to each product's API policy for the exact guarantee---usually binary compatibility is guaranteed at least across minor versions).

Note: since @PublicApi interfaces and classes are not designed to be implemented or extended by clients, we may perform certain types of binary-incompatible changes to these classes and interfaces, but these will not affect well-behaved clients that do not extend/implement these types (in general, only classes and interfaces annotated with @PublicSpi are safe to extend/implement).

Class Overview

Service that is used to get a list of Issue for the Issue Picker. This uses IssuePickerSearchProviders to get Issues.

Summary

Nested Classes
class IssuePickerSearchService.IssuePickerParameters Class for passing around IssuePicker parameters. 
Public Methods
Collection<IssuePickerResults> getResults(JiraServiceContext context, IssuePickerSearchService.IssuePickerParameters issuePickerParams)
Gets a list of Issue based on query string.

Public Methods

public Collection<IssuePickerResults> getResults (JiraServiceContext context, IssuePickerSearchService.IssuePickerParameters issuePickerParams)

Gets a list of Issue based on query string. Limited by maxIssueCount.

Parameters
context Jira Service Context
issuePickerParams params for picking issues
Returns
  • Collection of Issue matching search criteria. These can be any type of issues. This collection is never nulll.