Package 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 Details

    • getSearchers

      Collection<IssueSearcher<?>> getSearchers(ApplicationUser searcher, SearchContext context)
      Get searchers that are applicable for a given context. This is found through the {@link 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()
      Get all searcher groups. Note that the SearcherGroup will still appear even if no IssueSearcher are shown for the group.
      Returns:
      Collection of SearcherGroup

    • getSearcher

      IssueSearcher<?> getSearcher(String id)
      Get a searcher by the searchers name.
      Parameters:
      id - the string identifier returned by {@link 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