com.atlassian.jira.rest.client.api

Interface GroupRestClient

public interface GroupRestClient

The com.atlassian.jira.rest.client.api handling group resources.

Since:

v5.1.0

Method Summary

Modifier and Type	Method and Description
io.atlassian.util.concurrent.Promise<Iterable<Group>>	findGroups() Find all groups, limited by the system property "jira.ajax.autocomplete.limit"
io.atlassian.util.concurrent.Promise<Iterable<Group>>	findGroups(String query, String exclude, Integer maxResults, String userName) Returns groups with substrings matching a given query.

Method Detail

findGroups

io.atlassian.util.concurrent.Promise<Iterable<Group>> findGroups()

Find all groups, limited by the system property "jira.ajax.autocomplete.limit"

Returns:

list of groups

findGroups

io.atlassian.util.concurrent.Promise<Iterable<Group>> findGroups(@Nullable
                                                                 String query,
                                                                 @Nullable
                                                                 String exclude,
                                                                 @Nullable
                                                                 Integer maxResults,
                                                                 @Nullable
                                                                 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 against

exclude - Exclude groups

maxResults - The maximum number of groups to return

userName - A user name

Returns:

list of groups that match the search string