Summary: Methods | [Expand All]
@PublicApi public interface

IssueSearcherManager

com.atlassian.jira.issue.search.managers.IssueSearcherManager
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

Manager to obtain a list of IssueSearcher objects as well as SearcherGroup collections

Summary

Public Methods
Collection<IssueSearcher<?>> getAllSearchers()
Return all the active searchers in JIRA.
IssueSearcher<?> getSearcher(String id)
Get a searcher by the searchers name.
@Deprecated Collection<SearcherGroup> getSearcherGroups(SearchContext searchContext)
This method is deprecated. Since 6.3.4. The SearchContext parameter is no longer needed. Use getSearcherGroups()
Collection<SearcherGroup> getSearcherGroups()
Get all searcher groups.
Collection<IssueSearcher<?>> getSearchers(ApplicationUser searcher, SearchContext context)
Get searchers that are applicable for a given context.
void refresh()
Refreshes the IssueSearcher cache

Public Methods

public Collection<IssueSearcher<?>> getAllSearchers ()

Return all the active searchers in JIRA. It will not return the searchers unless they are associated with a field.

Returns
  • all the searchers in JIRA.

public IssueSearcher<?> getSearcher (String id)

Get a searcher by the searchers name.

Parameters
id the string identifier returned by com.atlassian.jira.issue.search.searchers.IssueSearcher#getSearchInformation()#getId()
Returns
  • the searcher matching the id, null if none is found.

@Deprecated public Collection<SearcherGroup> getSearcherGroups (SearchContext searchContext)

This method is deprecated.
Since 6.3.4. The SearchContext parameter is no longer needed. Use getSearcherGroups()

Get all searcher groups with the IssueSearcher that are applicable for the context. com.atlassian.jira.issue.search.searchers.IssueSearcher#getSearchRenderer()#isShown(SearchContext) method. Note that the SearcherGroup will still appear even if no IssueSearcher are shown for the group.

Parameters
searchContext for the searcher groups.
Returns

public Collection<SearcherGroup> getSearcherGroups ()

Get all searcher groups. Note that the SearcherGroup will still appear even if no IssueSearcher are shown for the group.

Returns

public Collection<IssueSearcher<?>> getSearchers (ApplicationUser searcher, SearchContext context)

Get searchers that are applicable for a given context. This is found through the com.atlassian.jira.issue.search.searchers.IssueSearcher#getSearchRenderer()#isShown(SearchContext) method.

Parameters
searcher that is performing this action.
context for the list of searchers. Must not be null
Returns

public void refresh ()

Refreshes the IssueSearcher cache