Package com.atlassian.jira.issue.search.searchers.information

Interface SearcherInformation<T extends SearchableField>

All Known Implementing Classes:
CustomFieldSearcherInformation, FeatureFlagGuardedSearcherInformation, GenericSearcherInformation, MockSearcherInformation
@PublicApi @PublicSpi public interface SearcherInformation<T extends SearchableField>
Identifies a searcher by name and provides a display name that is i18n'ed.
Since:
v4.0

  • Method Details

    • getId

      String getId()
      The unique id of the searcher.
      Returns:
      unique id of the searcher.

    • getNameKey

      String getNameKey()
      The i18n key that is used to lookup the searcher's name when it is displayed.
      Returns:
      i18n key that is used to lookup the searcher's name when it is displayed.

    • getField

      T getField()
      Returns:
      the field that this searcher was initialised with. If the searcher has not yet been initialised, this will return null.

    • getIndexers

      default List<FieldIndexer> getIndexers()
      Returns a list of FieldIndexer objects. The objects should be initialised and ready for action. Replaces Lucene-specific getRelatedIndexers()
      Returns:
      List of FieldIndexer objects. Must not be null. Return an empty list if none available

    • getRelatedIndexers

      @Deprecated(forRemoval=true) List<FieldIndexer> getRelatedIndexers()
      Deprecated, for removal: This API element is subject to removal in a future version.
      since 10.4, use getIndexers() instead.
      Returns a list of FieldIndexer objects. The objects should be initialised and ready for action
      Returns:
      List of FieldIndexer objects. Must not be null. Return an empty list if none available

    • getSearcherGroupType

      SearcherGroupType getSearcherGroupType()
      The searcher group the searcher should be placed in. Really only useful for system fields as custom fields are forced into the SearcherGroupType.CUSTOM group.
      Returns:
      the group the searcher should be associated with. Cannot not be null.