Package com.atlassian.jira.bc.group.search

Interface GroupPickerSearchService

All Known Implementing Classes:
GroupPickerSearchServiceImpl
@PublicApi public interface GroupPickerSearchService
Service that retrieves a collection of Group objects based on a partial query string
Since:
v4.4

  • Method Summary

    Modifier and Type
    Method
    Description
    List<com.atlassian.crowd.embedded.api.Group>
    findGroups(String query)
    Get groups based on a query string.
    com.atlassian.crowd.embedded.api.Group
    getGroupByName(String groupName)
    Returns a group by name.

  • Method Details

    • findGroups

      List<com.atlassian.crowd.embedded.api.Group> findGroups(String query)
      Get groups based on a query string. Will be unique and sorted.

      Results are sorted according to the GroupComparator.

      Parameters:
      query - String to search for.
      Returns:
      List of Group objects that match criteria.

    • getGroupByName

      com.atlassian.crowd.embedded.api.Group getGroupByName(String groupName)
      Returns a group by name.
      Parameters:
      groupName - The group name
      Returns:
      The group (if any)