com.atlassian.jira.issue.customfields.searchers.transformer

Interface CustomFieldInputHelper

All Known Implementing Classes:

DefaultCustomFieldInputHelper

public interface CustomFieldInputHelper

Provides help for constructing clauses for custom fields from Search Input Transformers.

Since:

v4.0

Method Summary

Modifier and Type	Method and Description
String	getUniqueClauseName(ApplicationUser user, String primaryName, String fieldName) Given the primary clause name and the field name, returns the "unique" clause name that should be used when constructing terminal clauses for this clause name.

Method Detail

getUniqueClauseName

String getUniqueClauseName(ApplicationUser user,
                           String primaryName,
                           String fieldName)

Given the primary clause name and the field name, returns the "unique" clause name that should be used when constructing terminal clauses for this clause name. Uniqueness is calculated per user; a name could be unique for one user since he only has limited view of fields, but for another user it could be non-unique.

Parameters:

user - the user performing the search

primaryName - the primary name of a clause, e.g. cf[10000] or project

fieldName - the name of the field associated to the clause, e.g. My Custom Field or project

Returns:

the clause name which should be used in construction of terminal clauses, to guarantee that this clause refers only to the one specific field.