@NonInjectableComponent public class

CascadingSelectCustomFieldSearchInputTransformer

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

Class Overview

The SearchInputTransformer for cascading select custom fields.

Summary

Public Constructors
CascadingSelectCustomFieldSearchInputTransformer(ClauseNames clauseNames, CustomField field, String urlParameterName, SelectConverter selectConverter, JqlOperandResolver jqlOperandResolver, JqlSelectOptionsUtil jqlSelectOptionsUtil, JqlCascadingSelectLiteralUtil jqlCascadingSelectLiteralUtil, QueryContextConverter queryContextConverter, 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.
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 CascadingSelectCustomFieldSearchInputTransformer (ClauseNames clauseNames, CustomField field, String urlParameterName, SelectConverter selectConverter, JqlOperandResolver jqlOperandResolver, JqlSelectOptionsUtil jqlSelectOptionsUtil, JqlCascadingSelectLiteralUtil jqlCascadingSelectLiteralUtil, QueryContextConverter queryContextConverter, 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.

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.