public class ProjectPickerResource extends Object
Constructor and Description |
---|
ProjectPickerResource(ProjectPicker projectPicker,
JiraAuthenticationContext authenticationContext) |
Modifier and Type | Method and Description |
---|---|
javax.ws.rs.core.Response |
searchForProjects(String query,
int maxResults,
boolean allowEmptyQuery)
Returns a list of projects visible to the user where project name and/or key is matching the given query.
|
@Autowired public ProjectPickerResource(ProjectPicker projectPicker, JiraAuthenticationContext authenticationContext)
public javax.ws.rs.core.Response searchForProjects(String query, int maxResults, boolean allowEmptyQuery)
Passing an empty (or whitespace only) query will match no projects. The project matches will contain a field with the query highlighted.
The number of projects returned can be controlled by passing a value for "maxResults", but a hard limit of no more than 100 projects is enforced. The projects are wrapped in a single response object that contains a header for use in the picker, specifically Showing X of Y matching projects and the total number of matches for the query.
query
- a sequence of characters expected to be found in the word-prefix of project name and/or key.maxResults
- maximum number of matches to return. Zero means a default limit of 100 and negative numbers return no results.allowEmptyQuery
- if true, and the query is empty, the method will return first results limited to the value of "maxResults" or default limit of 100.Copyright © 2002-2024 Atlassian. All Rights Reserved.