com.atlassian.jira.issue.customfields.searchers.transformer
Class UserPickerCustomFieldSearchInputTransformer

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

All Implemented Interfaces:

SearchInputTransformer

public class UserPickerCustomFieldSearchInputTransformer
extends AbstractSingleValueCustomFieldSearchInputTransformer
implements SearchInputTransformer

The SearchInputTransformer for user custom fields.

Since:

v4.0

Constructor Summary

UserPickerCustomFieldSearchInputTransformer(String urlParameterName, ClauseNames clauseNames, CustomField field, UserConverter userConverter, UserFitsNavigatorHelper userFitsNavigatorHelper, CustomFieldInputHelper customFieldInputHelper)

Method Summary

boolean	doRelevantClausesFitFilterForm(com.atlassian.crowd.embedded.api.User 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.
protected CustomFieldParams	getParamsFromSearchRequest(com.atlassian.crowd.embedded.api.User user, Query query, SearchContext searchContext) Gets CustomField search parameters from the given JQL Query.
void	validateParams(com.atlassian.crowd.embedded.api.User user, SearchContext searchContext, FieldValuesHolder fieldValuesHolder, I18nHelper i18nHelper, ErrorCollection errors) Adds error messages to the errors object if values in the fieldValuesHolder fails validation.

Methods inherited from class com.atlassian.jira.issue.customfields.searchers.transformer.AbstractSingleValueCustomFieldSearchInputTransformer

getClauseFromParams

Methods inherited from class com.atlassian.jira.issue.customfields.searchers.transformer.AbstractCustomFieldSearchInputTransformer

getClauseName, getCustomField, getSearchClause, populateFromParams, populateFromQuery

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.atlassian.jira.issue.search.searchers.transformer.SearchInputTransformer

getSearchClause, populateFromParams, populateFromQuery

Constructor Detail

UserPickerCustomFieldSearchInputTransformer

public UserPickerCustomFieldSearchInputTransformer(String urlParameterName,
                                                   ClauseNames clauseNames,
                                                   CustomField field,
                                                   UserConverter userConverter,
                                                   UserFitsNavigatorHelper userFitsNavigatorHelper,
                                                   CustomFieldInputHelper customFieldInputHelper)

Method Detail

validateParams

public void validateParams(com.atlassian.crowd.embedded.api.User user,
                           SearchContext searchContext,
                           FieldValuesHolder fieldValuesHolder,
                           I18nHelper i18nHelper,
                           ErrorCollection errors)

Description copied from interface: SearchInputTransformer

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

Specified by:

validateParams in interface SearchInputTransformer

Overrides:

validateParams in class AbstractCustomFieldSearchInputTransformer

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.

doRelevantClausesFitFilterForm

public boolean doRelevantClausesFitFilterForm(com.atlassian.crowd.embedded.api.User user,
                                              Query query,
                                              SearchContext searchContext)

Description copied from interface: SearchInputTransformer

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.

Specified by:

doRelevantClausesFitFilterForm in interface SearchInputTransformer

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.

getParamsFromSearchRequest

protected CustomFieldParams getParamsFromSearchRequest(com.atlassian.crowd.embedded.api.User user,
                                                       Query query,
                                                       SearchContext searchContext)

Description copied from class: AbstractCustomFieldSearchInputTransformer

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

Overrides:

getParamsFromSearchRequest in class AbstractSingleValueCustomFieldSearchInputTransformer

Parameters:

user - User

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.