com.atlassian.jira.rest.v2.issue

Class GroupPickerResource

java.lang.Object

com.atlassian.jira.rest.v2.issue.GroupPickerResource

public class GroupPickerResource
extends Object

REST endpoint for searching groups in a group picker

Since:

v4.4

Constructor Summary

Constructors

Constructor and Description
GroupPickerResource(GroupPickerResourceHelper groupPickerHelper)

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	findGroups(String query, List<String> excludeGroups, Integer maxResults, String userName) Returns groups with substrings matching a given query.

Methods inherited from class java.lang.Object

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

Constructor Detail

GroupPickerResource

public GroupPickerResource(GroupPickerResourceHelper groupPickerHelper)

Method Detail

findGroups

public javax.ws.rs.core.Response findGroups(String query,
                                            List<String> excludeGroups,
                                            Integer maxResults,
                                            String userName)

Returns groups with substrings matching a given query. This is mainly for use with the group picker, so the returned groups contain html to be used as picker suggestions. The groups are also wrapped in a single response object that also contains a header for use in the picker, specifically Showing X of Y matching groups.

The number of groups returned is limited by the system property "jira.ajax.autocomplete.limit"

The groups will be unique and sorted.

Parameters:

query - a String to match groups agains

Returns:

a collection of matching groups