public class

UserPickerCustomFieldSearchInputTransformer

extends AbstractSingleValueCustomFieldSearchInputTransformer
implements SearchInputTransformer
java.lang.Object
   ↳ com.atlassian.jira.issue.customfields.searchers.transformer.AbstractCustomFieldSearchInputTransformer
     ↳ com.atlassian.jira.issue.customfields.searchers.transformer.AbstractSingleValueCustomFieldSearchInputTransformer
       ↳ com.atlassian.jira.issue.customfields.searchers.transformer.UserPickerCustomFieldSearchInputTransformer

Class Overview

The SearchInputTransformer for user custom fields.

Summary

Public Constructors
UserPickerCustomFieldSearchInputTransformer(String urlParameterName, ClauseNames clauseNames, CustomField field, UserConverter userConverter, UserFitsNavigatorHelper userFitsNavigatorHelper, CustomFieldInputHelper customFieldInputHelper)
Public Methods
boolean doRelevantClausesFitFilterForm(ApplicationUser user, Query query, SearchContext searchContext)
Tells the caller whether or not the relevant clauses from the passed query can be represented on the issue navigator.
void validateParams(ApplicationUser user, SearchContext searchContext, FieldValuesHolder fieldValuesHolder, I18nHelper i18nHelper, ErrorCollection errors)
Adds error messages to the errors object if values in the fieldValuesHolder fails validation.
Protected Methods
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.AbstractSingleValueCustomFieldSearchInputTransformer
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 UserPickerCustomFieldSearchInputTransformer (String urlParameterName, ClauseNames clauseNames, CustomField field, UserConverter userConverter, UserFitsNavigatorHelper userFitsNavigatorHelper, CustomFieldInputHelper customFieldInputHelper)

Public Methods

public boolean doRelevantClausesFitFilterForm (ApplicationUser user, Query query, SearchContext searchContext)

Tells the caller whether or not the relevant clauses from the passed query can be represented on the issue navigator. Implementers of this method needs to ensure that it can represent *ALL* related clauses on the navigator, and that the clauses' structure conforms to the simple navigator structure.

The method should only be concerned with the clauses related to this transformer. Other irrelevant clauses should be ignored.

Parameters
user performing this action.
query to check if it can fit in the simple (GUI form based) issue navigator.
searchContext contains the projects and issue types that the search and filter form is restricted to
Returns
  • true if the query can be represented on navigator.

public void validateParams (ApplicationUser user, SearchContext searchContext, FieldValuesHolder fieldValuesHolder, I18nHelper i18nHelper, ErrorCollection errors)

Adds error messages to the errors object if values in the fieldValuesHolder fails validation. This should be called once the fieldValuesHolder has been populated.

Parameters
user performing this action.
searchContext the context of the search (i.e. projects and issue types selected).
fieldValuesHolder contains values populated by the populate methods of this input transformer.
i18nHelper used to internationalize error messages that we want to display to the users.
errors the ErrorCollection that contains the messages we want to display to the users.

Protected Methods

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.