com.atlassian.jira.issue.search.managers
Interface IssueSearcherManager

All Known Implementing Classes:

DefaultIssueSearcherManager

@PublicApi
public interface IssueSearcherManager

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

Method Summary

Collection<IssueSearcher<?>>	getAllSearchers() Return all the active searchers in JIRA.
IssueSearcher<?>	getSearcher(String id) Get a searcher by the searchers name.
Collection<SearcherGroup>	getSearcherGroups(SearchContext searchContext) Get all searcher groups with the IssueSearcher that are applicable for the context.
Collection<IssueSearcher<?>>	getSearchers(com.atlassian.crowd.embedded.api.User searcher, SearchContext context) Get searchers that are applicable for a given context.
void	refresh() Refreshes the IssueSearcher cache

Method Detail

getSearchers

Collection<IssueSearcher<?>> getSearchers(com.atlassian.crowd.embedded.api.User 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:

Collection of IssueSearcher

getAllSearchers

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.

getSearcherGroups

Collection<SearcherGroup> getSearcherGroups(SearchContext searchContext)

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:

Collection of SearcherGroup

getSearcher

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.

refresh

void refresh()

Refreshes the IssueSearcher cache