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

IssueSearcher

com.atlassian.jira.issue.search.searchers.IssueSearcher<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

The interface defines an object responsible for all search related activities in the Issue Navigator. The interface operates similar to the Field objects (e.g. OrderableField. It is responsible for populating itself from ActionParams and SearchRequest as well as all rendering related activities.

CustomField searchers should still extend the sub-interface CustomFieldSearcher.

Summary

Fields
public static final Logger log
Public Methods
SearcherInformation<T> getSearchInformation()
Provides an object that contains information about the Searcher.
SearchInputTransformer getSearchInputTransformer()
Provides an object that will allow you to transform raw request parameters to field holder values and field holder values to Clause search representations.
SearchRenderer getSearchRenderer()
Provides an object that will allow you to render the edit and view html for a searcher.
void init(T field)
Initialises the searcher with a given field.

Fields

public static final Logger log

Public Methods

public SearcherInformation<T> getSearchInformation ()

Provides an object that contains information about the Searcher.

Returns
  • the search information provider for this searcher.

public SearchInputTransformer getSearchInputTransformer ()

Provides an object that will allow you to transform raw request parameters to field holder values and field holder values to Clause search representations.

Returns
  • the search input handler for this searcher.

public SearchRenderer getSearchRenderer ()

Provides an object that will allow you to render the edit and view html for a searcher. This also provides methods that indicate if the view and edit methods should be invoked.

Returns
  • the search renderer for this searcher.

public void init (T field)

Initialises the searcher with a given field.

Parameters
field the field object. This may be null. (So you can have searchers on non-fields)