public class

KickassUserSearchInputTransformer

extends UserSearchInputTransformer
java.lang.Object
   ↳ com.atlassian.jira.issue.search.searchers.transformer.UserSearchInputTransformer
     ↳ com.atlassian.jira.issue.search.searchers.transformer.KickassUserSearchInputTransformer

Class Overview

A search input transformer for user/group fields with Kickass modifications.

Summary

[Expand]
Inherited Fields
From class com.atlassian.jira.issue.search.searchers.transformer.UserSearchInputTransformer
Public Constructors
KickassUserSearchInputTransformer(UserFieldSearchConstantsWithEmpty searchConstants, UserFitsNavigatorHelper userFitsNavigatorHelper, GroupManager groupManager, UserManager userManager, UserHistoryManager userHistoryManager)
KickassUserSearchInputTransformer(UserFieldSearchConstants searchConstants, UserFitsNavigatorHelper userFitsNavigatorHelper, GroupManager groupManager, UserManager userManager, UserHistoryManager userHistoryManager)
KickassUserSearchInputTransformer(UserFieldSearchConstants searchConstants, UserFitsNavigatorHelper userFitsNavigatorHelper, GroupManager groupManager, UserManager userManager, UserHistoryManager userHistoryManager, CustomField customField, CustomFieldInputHelper customFieldInputHelper)
Public Methods
boolean doRelevantClausesFitFilterForm(ApplicationUser user, Query query, SearchContext searchContext)
Determines whether the given query can be represented in basic mode.
Clause getSearchClause(ApplicationUser user, FieldValuesHolder fieldValuesHolder)
Convert the user's input into a JQL clause.
void populateFromParams(ApplicationUser user, FieldValuesHolder fieldValuesHolder, ActionParams actionParams)
void populateFromQuery(ApplicationUser user, FieldValuesHolder fieldValuesHolder, Query query, SearchContext searchContext)
Populates a FieldValuesHolder from a Query.
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.
[Expand]
Inherited Methods
From class com.atlassian.jira.issue.search.searchers.transformer.UserSearchInputTransformer
From class java.lang.Object
From interface com.atlassian.jira.issue.search.searchers.transformer.SearchInputTransformer

Public Constructors

public KickassUserSearchInputTransformer (UserFieldSearchConstantsWithEmpty searchConstants, UserFitsNavigatorHelper userFitsNavigatorHelper, GroupManager groupManager, UserManager userManager, UserHistoryManager userHistoryManager)

public KickassUserSearchInputTransformer (UserFieldSearchConstants searchConstants, UserFitsNavigatorHelper userFitsNavigatorHelper, GroupManager groupManager, UserManager userManager, UserHistoryManager userHistoryManager)

public KickassUserSearchInputTransformer (UserFieldSearchConstants searchConstants, UserFitsNavigatorHelper userFitsNavigatorHelper, GroupManager groupManager, UserManager userManager, UserHistoryManager userHistoryManager, CustomField customField, CustomFieldInputHelper customFieldInputHelper)

Public Methods

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

Determines whether the given query can be represented in basic mode.

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 Clause getSearchClause (ApplicationUser user, FieldValuesHolder fieldValuesHolder)

Convert the user's input into a JQL clause. Always in the form:

field IN (user1, user2, membersOf(group1), membersOf(group2), ...)

Parameters
user performing this action.
fieldValuesHolder contains values populated by the searchers
Returns
  • a Clause that represents the users search based on the fieldValuesHolder; null if this searcher has no responsibility in the given input.

public void populateFromParams (ApplicationUser user, FieldValuesHolder fieldValuesHolder, ActionParams actionParams)

Populates a FieldValuesHolder with ActionParams.

Values that start with "user:" refer to users, values that start with "group:" refers to groups, and "empty" refers to empty values.

Parameters
user performing this action.
fieldValuesHolder is the object that should have its values set by this method and that will contain any other values that have been set by other SearchInputTransformers.
actionParams params from the webwork front end that contains a String[] of values as submitted via the

public void populateFromQuery (ApplicationUser user, FieldValuesHolder fieldValuesHolder, Query query, SearchContext searchContext)

Populates a FieldValuesHolder from a Query.

Parameters
user performing this action.
fieldValuesHolder is the object that should have its values set by this method and that will contain any other values that have been set by other SearchInputTransformers.
query the search criteria used to populate the field values holder.
searchContext contains the projects and issue types that the search and filter form is restricted to

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.