Class CascadingSelectCustomFieldSearchInputTransformer
java.lang.Object
com.atlassian.jira.issue.customfields.searchers.transformer.AbstractCustomFieldSearchInputTransformer
com.atlassian.jira.issue.customfields.searchers.transformer.CascadingSelectCustomFieldSearchInputTransformer
- All Implemented Interfaces:
SearchInputTransformer
@NonInjectableComponent
public class CascadingSelectCustomFieldSearchInputTransformer
extends AbstractCustomFieldSearchInputTransformer
implements SearchInputTransformer
The
SearchInputTransformer
for cascading select custom fields.- Since:
- v4.0
-
Constructor Summary
ConstructorsConstructorDescriptionCascadingSelectCustomFieldSearchInputTransformer(ClauseNames clauseNames, CustomField field, String urlParameterName, SelectConverter selectConverter, JqlOperandResolver jqlOperandResolver, JqlSelectOptionsUtil jqlSelectOptionsUtil, JqlCascadingSelectLiteralUtil jqlCascadingSelectLiteralUtil, QueryContextConverter queryContextConverter, CustomFieldInputHelper customFieldInputHelper) -
Method Summary
Modifier and TypeMethodDescriptionbooleandoRelevantClausesFitFilterForm(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 ClausegetClauseFromParams(ApplicationUser user, CustomFieldParams customFieldParams) Note: only provide a sensible implementation of this if you intend on usingAbstractCustomFieldSearchInputTransformer.getSearchClause(com.atlassian.jira.user.ApplicationUser, com.atlassian.jira.issue.transport.FieldValuesHolder)as implemented here.protected CustomFieldParamsgetParamsFromSearchRequest(ApplicationUser user, Query query, SearchContext searchContext) Gets CustomField search parameters from the given JQL Query.Methods inherited from class com.atlassian.jira.issue.customfields.searchers.transformer.AbstractCustomFieldSearchInputTransformer
getClauseName, getCustomField, getSearchClause, populateFromParams, populateFromQuery, validateParamsMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface com.atlassian.jira.issue.search.searchers.transformer.SearchInputTransformer
getSearchClause, populateFromParams, populateFromQuery, validateParams
-
Constructor Details
-
CascadingSelectCustomFieldSearchInputTransformer
public CascadingSelectCustomFieldSearchInputTransformer(ClauseNames clauseNames, CustomField field, String urlParameterName, SelectConverter selectConverter, JqlOperandResolver jqlOperandResolver, JqlSelectOptionsUtil jqlSelectOptionsUtil, JqlCascadingSelectLiteralUtil jqlCascadingSelectLiteralUtil, QueryContextConverter queryContextConverter, CustomFieldInputHelper customFieldInputHelper)
-
-
Method Details
-
doRelevantClausesFitFilterForm
public boolean doRelevantClausesFitFilterForm(ApplicationUser user, Query query, SearchContext searchContext) Description copied from interface:SearchInputTransformerTells 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:
doRelevantClausesFitFilterFormin interfaceSearchInputTransformer- 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.
-
getClauseFromParams
Description copied from class:AbstractCustomFieldSearchInputTransformerNote: only provide a sensible implementation of this if you intend on usingAbstractCustomFieldSearchInputTransformer.getSearchClause(com.atlassian.jira.user.ApplicationUser, com.atlassian.jira.issue.transport.FieldValuesHolder)as implemented here. If you are overridingAbstractCustomFieldSearchInputTransformer.getSearchClause(com.atlassian.jira.user.ApplicationUser, com.atlassian.jira.issue.transport.FieldValuesHolder)then you do not have to implement this method sensibly.- Specified by:
getClauseFromParamsin classAbstractCustomFieldSearchInputTransformer- Parameters:
user- the user performing the searchcustomFieldParams- the custom field params- Returns:
- the clause that represents the params
-
getParamsFromSearchRequest
protected CustomFieldParams getParamsFromSearchRequest(ApplicationUser user, Query query, SearchContext searchContext) Description copied from class:AbstractCustomFieldSearchInputTransformerGets 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".
- Specified by:
getParamsFromSearchRequestin classAbstractCustomFieldSearchInputTransformer- Parameters:
user- com.atlassian.jira.user.ApplicationUserquery- JQL querysearchContext- contains the projects and issue types that the search is restricted to- Returns:
- CustomField search parameters from the given JQL Query.
-