public class MultiSelectCustomFieldSearchInputTransformer extends AbstractCustomFieldSearchInputTransformer implements SearchInputTransformer
SearchInputTransformer
for custom fields with multi-select searchers (multi-select and check boxes)Constructor and Description |
---|
MultiSelectCustomFieldSearchInputTransformer(String urlParameterName,
ClauseNames clauseNames,
CustomField field,
JqlOperandResolver jqlOperandResolver,
JqlSelectOptionsUtil jqlSelectOptionsUtil,
QueryContextConverter queryContextConverter,
CustomFieldInputHelper customFieldInputHelper) |
Modifier and Type | Method and Description |
---|---|
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.
|
protected Clause |
getClauseFromParams(ApplicationUser user,
CustomFieldParams params)
Note: only provide a sensible implementation of this if you intend on using
AbstractCustomFieldSearchInputTransformer.getSearchClause(com.atlassian.jira.user.ApplicationUser, com.atlassian.jira.issue.transport.FieldValuesHolder)
as implemented here. |
protected CustomFieldParams |
getParamsFromSearchRequest(ApplicationUser user,
Query query,
SearchContext searchContext)
Gets CustomField search parameters from the given JQL Query.
|
protected boolean |
isValidOperatorForFitness(Operator operator) |
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.
|
getClauseName, getCustomField, getSearchClause, populateFromParams, populateFromQuery
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
getSearchClause, populateFromParams, populateFromQuery
public MultiSelectCustomFieldSearchInputTransformer(String urlParameterName, ClauseNames clauseNames, CustomField field, JqlOperandResolver jqlOperandResolver, JqlSelectOptionsUtil jqlSelectOptionsUtil, QueryContextConverter queryContextConverter, CustomFieldInputHelper customFieldInputHelper)
protected Clause getClauseFromParams(ApplicationUser user, CustomFieldParams params)
AbstractCustomFieldSearchInputTransformer
AbstractCustomFieldSearchInputTransformer.getSearchClause(com.atlassian.jira.user.ApplicationUser, com.atlassian.jira.issue.transport.FieldValuesHolder)
as implemented here. If you are overriding AbstractCustomFieldSearchInputTransformer.getSearchClause(com.atlassian.jira.user.ApplicationUser, com.atlassian.jira.issue.transport.FieldValuesHolder)
then you do not have to implement this method sensibly.getClauseFromParams
in class AbstractCustomFieldSearchInputTransformer
user
- the user performing the searchparams
- the custom field paramsprotected CustomFieldParams getParamsFromSearchRequest(ApplicationUser user, Query query, SearchContext searchContext)
AbstractCustomFieldSearchInputTransformer
It may return null, indicating no search parameters for this searcher were specified, or the query will not fit into the "simple navigator".
getParamsFromSearchRequest
in class AbstractCustomFieldSearchInputTransformer
user
- com.atlassian.jira.user.ApplicationUserquery
- JQL querysearchContext
- contains the projects and issue types that the search is restricted toprotected boolean isValidOperatorForFitness(Operator operator)
public boolean doRelevantClausesFitFilterForm(ApplicationUser user, Query query, SearchContext searchContext)
SearchInputTransformer
The method should only be concerned with the clauses related to this transformer. Other irrelevant clauses should be ignored.
doRelevantClausesFitFilterForm
in interface SearchInputTransformer
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 topublic void validateParams(ApplicationUser user, SearchContext searchContext, FieldValuesHolder fieldValuesHolder, I18nHelper i18nHelper, ErrorCollection errors)
SearchInputTransformer
validateParams
in interface SearchInputTransformer
validateParams
in class AbstractCustomFieldSearchInputTransformer
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.Copyright © 2002-2024 Atlassian. All Rights Reserved.