@PublicSpi public abstract class

AbstractSingleValueCustomFieldSearchInputTransformer

extends AbstractCustomFieldSearchInputTransformer
java.lang.Object
   ↳ com.atlassian.jira.issue.customfields.searchers.transformer.AbstractCustomFieldSearchInputTransformer
     ↳ com.atlassian.jira.issue.customfields.searchers.transformer.AbstractSingleValueCustomFieldSearchInputTransformer
Known Direct Subclasses

@PublicSpi

This class 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

An abstract Search Input Transformer for custom fields that only allow a single value and no functions in the Navigator.

Summary

Public Constructors
AbstractSingleValueCustomFieldSearchInputTransformer(CustomField field, ClauseNames clauseNames, String urlParameterName, CustomFieldInputHelper customFieldInputHelper)
Protected Methods
Clause getClauseFromParams(ApplicationUser user, CustomFieldParams customFieldParams)
Note: only provide a sensible implementation of this if you intend on using getSearchClause(com.atlassian.jira.user.ApplicationUser, com.atlassian.jira.issue.transport.FieldValuesHolder) as implemented here.
CustomFieldParams getParamsFromSearchRequest(ApplicationUser user, Query query, SearchContext searchContext)
Gets CustomField search parameters from the given JQL Query.
[Expand]
Inherited Methods
From class com.atlassian.jira.issue.customfields.searchers.transformer.AbstractCustomFieldSearchInputTransformer
From class java.lang.Object
From interface com.atlassian.jira.issue.search.searchers.transformer.SearchInputTransformer

Public Constructors

public AbstractSingleValueCustomFieldSearchInputTransformer (CustomField field, ClauseNames clauseNames, String urlParameterName, CustomFieldInputHelper customFieldInputHelper)

Protected Methods

protected Clause getClauseFromParams (ApplicationUser user, CustomFieldParams customFieldParams)

Note: only provide a sensible implementation of this if you intend on using getSearchClause(com.atlassian.jira.user.ApplicationUser, com.atlassian.jira.issue.transport.FieldValuesHolder) as implemented here. If you are overriding getSearchClause(com.atlassian.jira.user.ApplicationUser, com.atlassian.jira.issue.transport.FieldValuesHolder) then you do not have to implement this method sensibly.

Parameters
user the user performing the search
customFieldParams the custom field params
Returns
  • the clause that represents the params

protected CustomFieldParams getParamsFromSearchRequest (ApplicationUser user, Query query, SearchContext searchContext)

Gets CustomField search parameters from the given JQL Query.

It may return null, indicating no search parameters for this searcher were specified, or the query will not fit into the "simple navigator".

Parameters
user com.atlassian.jira.user.ApplicationUser
query JQL query
searchContext contains the projects and issue types that the search is restricted to
Returns
  • CustomField search parameters from the given JQL Query.