com.atlassian.jira.rest.v2.search

Class SearchAutoCompleteResource

java.lang.Object

com.atlassian.jira.rest.v2.search.SearchAutoCompleteResource

public class SearchAutoCompleteResource
extends Object

Resource for auto complete data for searches.

Since:

v5.1

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SearchAutoCompleteResource.AutoCompleteResultBean
static class	SearchAutoCompleteResource.AutoCompleteResultWrapper
static class	SearchAutoCompleteResource.JqlAutocompleteDataPermissionsAnalyticsEvent

Field Summary

Fields

Modifier and Type	Field and Description
static String	DOC_EXAMPLE
static org.slf4j.Logger	log
static SearchAutoCompleteResource.AutoCompleteResultWrapper	SUGGESTIONS_DOC_EXAMPLE

Constructor Summary

Constructors

Constructor and Description

SearchAutoCompleteResource(AutoCompleteJsonGenerator autoCompleteJsonGenerator, JiraAuthenticationContext authContext, I18nHelper i18n, FieldAndPredicateAutoCompleteResultGenerator fieldAndPredicateAutoCompleteResultGenerator, LastJqlFieldsService lastJqlFieldsService, com.atlassian.event.api.EventPublisher eventPublisher, AccessDisablingHelper accessDisablingHelper, PermissionManager permissionManager)

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	getAutoComplete(String requestedWith) Returns the auto complete data required for JQL searches.
javax.ws.rs.core.Response	getFieldAutoCompleteForQueryString(String fieldName, String fieldValue, String predicateName, String predicateValue) Returns auto complete suggestions for JQL search.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

log

public static final org.slf4j.Logger log

DOC_EXAMPLE

public static final String DOC_EXAMPLE

See Also:

Constant Field Values

SUGGESTIONS_DOC_EXAMPLE

public static final SearchAutoCompleteResource.AutoCompleteResultWrapper SUGGESTIONS_DOC_EXAMPLE

Constructor Detail

SearchAutoCompleteResource

public SearchAutoCompleteResource(AutoCompleteJsonGenerator autoCompleteJsonGenerator,
                                  JiraAuthenticationContext authContext,
                                  I18nHelper i18n,
                                  FieldAndPredicateAutoCompleteResultGenerator fieldAndPredicateAutoCompleteResultGenerator,
                                  LastJqlFieldsService lastJqlFieldsService,
                                  com.atlassian.event.api.EventPublisher eventPublisher,
                                  AccessDisablingHelper accessDisablingHelper,
                                  PermissionManager permissionManager)

Method Detail

getAutoComplete

public javax.ws.rs.core.Response getAutoComplete(@HeaderParam(value="X-Requested-With")
                                                 String requestedWith)

Returns the auto complete data required for JQL searches.

Returns:

the auto complete data required for JQL searches.

getFieldAutoCompleteForQueryString

public javax.ws.rs.core.Response getFieldAutoCompleteForQueryString(String fieldName,
                                                                    String fieldValue,
                                                                    String predicateName,
                                                                    String predicateValue)

Returns auto complete suggestions for JQL search.

Parameters:

fieldName - the field name for which the suggestions are generated.

fieldValue - the portion of the field value that has already been provided by the user.

predicateName - the predicate for which the suggestions are generated. Suggestions are generated only for: "by", "from" and "to".

predicateValue - the portion of the predicate value that has already been provided by the user.

Returns:

a Response containing a list of AutoCompleteResource.AutoCompleteResultBean's containing the matching autocomplete values