@PublicApi @PublicSpi public interface

SearcherInformation

com.atlassian.jira.issue.search.searchers.information.SearcherInformation<T extends com.atlassian.jira.issue.fields.SearchableField>
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).

@PublicSpi

This interface is designed for plugins to implement.

Clients of @PublicSpi can expect that programs compiled against a given version will remain binary compatible with later versions of the @PublicSpi as per each product's API policy (clients should refer to each product's API policy for the exact guarantee -- usually binary compatibility is guaranteed at least across minor versions).

Note: @PublicSpi interfaces and classes are specifically designed to be implemented/extended by clients. Hence, the guarantee of binary compatibility is different to that of @PublicApi elements (if an element is both @PublicApi and @PublicSpi, both guarantees apply).

Class Overview

Identifies a searcher by name and provides a display name that is i18n'ed.

Summary

Public Methods
T getField()
String getId()
The unique id of the searcher.
String getNameKey()
The i18n key that is used to lookup the searcher's name when it is displayed.
List<FieldIndexer> getRelatedIndexers()
Returns a list of FieldIndexer objects.
SearcherGroupType getSearcherGroupType()
The searcher group the searcher should be placed in.

Public Methods

public T getField ()

Returns
  • the field that this searcher was initialised with. If the searcher has not yet been initialised, this will return null.

public String getId ()

The unique id of the searcher.

Returns
  • unique id of the searcher.

public 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.

public List<FieldIndexer> getRelatedIndexers ()

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

public SearcherGroupType getSearcherGroupType ()

The searcher group the searcher should be placed in. Really only useful for system fields as custom fields are forced into the CUSTOM group.

Returns
  • the group the searcher should be associated with. Cannot not be null.