public class

DefaultAutoCompleteJsonGenerator

extends Object
implements AutoCompleteJsonGenerator
java.lang.Object
   ↳ com.atlassian.jira.web.component.jql.DefaultAutoCompleteJsonGenerator

Summary

Public Constructors
DefaultAutoCompleteJsonGenerator(SearchHandlerManager searchHandlerManager, JqlStringSupport jqlStringSupport, FieldManager fieldManager, JqlFunctionHandlerRegistry jqlFunctionHandlerRegistry)
Public Methods
String getJqlReservedWordsJson()
String getVisibleFieldNamesJson(ApplicationUser user, Locale locale)
Will return an array of JSON objects containing the field names that the user can see, listed in alphabetical order.
String getVisibleFunctionNamesJson(ApplicationUser user, Locale locale)
Will return an array of JSON objects containing the functions names that are available in the system, listed in alphabetical order.
[Expand]
Inherited Methods
From class java.lang.Object
From interface com.atlassian.jira.web.component.jql.AutoCompleteJsonGenerator

Public Constructors

public DefaultAutoCompleteJsonGenerator (SearchHandlerManager searchHandlerManager, JqlStringSupport jqlStringSupport, FieldManager fieldManager, JqlFunctionHandlerRegistry jqlFunctionHandlerRegistry)

Public Methods

public String getJqlReservedWordsJson ()

Throws
JSONException

public String getVisibleFieldNamesJson (ApplicationUser user, Locale locale)

Will return an array of JSON objects containing the field names that the user can see, listed in alphabetical order.

The JSON object will contain: value: value that will be autocompleted displayName: the html escaped display name for the value auto (optional) : if present indicates that the field can have values autocompleted orderable (optional) : if present indicates that the field can participate in the order by clause cfid (optional) : if present indicates that the field is a custom field that can be referenced by cf[xxxxx]

Parameters
user that the page is being rendered for.
locale the locale of the user.
Returns
  • JSON string as described above.
Throws
JSONException

public String getVisibleFunctionNamesJson (ApplicationUser user, Locale locale)

Will return an array of JSON objects containing the functions names that are available in the system, listed in alphabetical order.

The JSON object will contain: value: value that will be autocompleted displayName: the html escaped display name for the value isList (optional) : true if the function generates a list of values, used to determine if it can work with the in operators.

Parameters
user that the page is being rendered for.
locale the locale of the user.
Returns
  • JSON string as described above
Throws
JSONException