public class

VersionCustomFieldSearchInputTransformer

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

Class Overview

The SearchInputTransformer for Version custom fields.

Summary

Public Constructors
VersionCustomFieldSearchInputTransformer(String urlParameterName, ClauseNames clauseNames, CustomField field, IndexInfoResolver<Version> indexInfoResolver, JqlOperandResolver operandResolver, FieldFlagOperandRegistry fieldFlagOperandRegistry, NameResolver<Version> versionResolver, CustomFieldInputHelper customFieldInputHelper, VersionManager versionManager)
@Deprecated VersionCustomFieldSearchInputTransformer(String urlParameterName, ClauseNames clauseNames, CustomField field, IndexInfoResolver<Version> indexInfoResolver, JqlOperandResolver operandResolver, FieldFlagOperandRegistry fieldFlagOperandRegistry, SearchContextVisibilityChecker searchContextVisibilityChecker, NameResolver<Version> versionResolver, CustomFieldInputHelper customFieldInputHelper, VersionManager versionManager)
Public Methods
boolean doRelevantClausesFitFilterForm(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.
Clause getSearchClause(User user, FieldValuesHolder fieldValuesHolder)
Gets the portion of the Search Query that this searcher is responsible for.
Protected Methods
Clause getClauseFromParams(User user, CustomFieldParams params)
Note: only provide a sensible implementation of this if you intend on using getSearchClause(User, com.atlassian.jira.issue.transport.FieldValuesHolder) as implemented here.
Clause getClauseFromParams(User user, CustomFieldParams params, FieldValuesHolder fieldValuesHolder)
CustomFieldParams getParamsFromSearchRequest(User 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 VersionCustomFieldSearchInputTransformer (String urlParameterName, ClauseNames clauseNames, CustomField field, IndexInfoResolver<Version> indexInfoResolver, JqlOperandResolver operandResolver, FieldFlagOperandRegistry fieldFlagOperandRegistry, NameResolver<Version> versionResolver, CustomFieldInputHelper customFieldInputHelper, VersionManager versionManager)

@Deprecated public VersionCustomFieldSearchInputTransformer (String urlParameterName, ClauseNames clauseNames, CustomField field, IndexInfoResolver<Version> indexInfoResolver, JqlOperandResolver operandResolver, FieldFlagOperandRegistry fieldFlagOperandRegistry, SearchContextVisibilityChecker searchContextVisibilityChecker, NameResolver<Version> versionResolver, CustomFieldInputHelper customFieldInputHelper, VersionManager versionManager)

Public Methods

public boolean doRelevantClausesFitFilterForm (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. Implementors 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.

public Clause getSearchClause (User user, FieldValuesHolder fieldValuesHolder)

Gets the portion of the Search Query that this searcher is responsible for.

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.

Protected Methods

protected Clause getClauseFromParams (User user, CustomFieldParams params)

Note: only provide a sensible implementation of this if you intend on using getSearchClause(User, com.atlassian.jira.issue.transport.FieldValuesHolder) as implemented here. If you are overriding getSearchClause(User, com.atlassian.jira.issue.transport.FieldValuesHolder) then you do not have to implement this method sensibly.

Parameters
user the user performing the search
params the custom field params
Returns
  • the clause that represents the params

protected Clause getClauseFromParams (User user, CustomFieldParams params, FieldValuesHolder fieldValuesHolder)

protected CustomFieldParams getParamsFromSearchRequest (User 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 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.