GroupsCollection (Gerrit Review Plugin API Documentation)

java.lang.Object
- com.google.gerrit.server.group.GroupsCollection

All Implemented Interfaces:: com.google.gerrit.extensions.restapi.AcceptsCreate<com.google.gerrit.extensions.restapi.TopLevelResource>, com.google.gerrit.extensions.restapi.RestCollection<com.google.gerrit.extensions.restapi.TopLevelResource,GroupResource>

public class GroupsCollection
extends java.lang.Object
implements com.google.gerrit.extensions.restapi.RestCollection<com.google.gerrit.extensions.restapi.TopLevelResource,GroupResource>, com.google.gerrit.extensions.restapi.AcceptsCreate<com.google.gerrit.extensions.restapi.TopLevelResource>

Method Summary

Methods
Modifier and Type	Method and Description
`CreateGroup`	`create(com.google.gerrit.extensions.restapi.TopLevelResource root, com.google.gerrit.extensions.restapi.IdString name)`
`com.google.gerrit.extensions.restapi.RestView<com.google.gerrit.extensions.restapi.TopLevelResource>`	`list()`
`com.google.gerrit.common.data.GroupDescription.Basic`	`parse(java.lang.String id)` Parses a group ID from a request body and returns the group.
`GroupResource`	`parse(com.google.gerrit.extensions.restapi.TopLevelResource parent, com.google.gerrit.extensions.restapi.IdString id)`
`com.google.gerrit.common.data.GroupDescription.Basic`	`parseId(java.lang.String id)` Parses a group ID and returns the group without making any permission check whether the current user can see the group.
`com.google.gerrit.common.data.GroupDescription.Basic`	`parseInternal(java.lang.String id)` Parses a group ID from a request body and returns the group if it is a Gerrit internal group.
`com.google.gerrit.extensions.registration.DynamicMap<com.google.gerrit.extensions.restapi.RestView<GroupResource>>`	`views()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - list
```
public com.google.gerrit.extensions.restapi.RestView<com.google.gerrit.extensions.restapi.TopLevelResource> list()
                                                                                                          throws com.google.gerrit.extensions.restapi.ResourceNotFoundException,
                                                                                                                 com.google.gerrit.extensions.restapi.AuthException
```
    Specified by:
    
    list in interface com.google.gerrit.extensions.restapi.RestCollection<com.google.gerrit.extensions.restapi.TopLevelResource,GroupResource>
    
    Throws:
    
    com.google.gerrit.extensions.restapi.ResourceNotFoundException
    
    com.google.gerrit.extensions.restapi.AuthException
  - parse
```
public GroupResource parse(com.google.gerrit.extensions.restapi.TopLevelResource parent,
                  com.google.gerrit.extensions.restapi.IdString id)
                    throws com.google.gerrit.extensions.restapi.AuthException,
                           com.google.gerrit.extensions.restapi.ResourceNotFoundException
```
    Specified by:
    
    parse in interface com.google.gerrit.extensions.restapi.RestCollection<com.google.gerrit.extensions.restapi.TopLevelResource,GroupResource>
    
    Throws:
    
    com.google.gerrit.extensions.restapi.AuthException
    
    com.google.gerrit.extensions.restapi.ResourceNotFoundException
  - parse
```
public com.google.gerrit.common.data.GroupDescription.Basic parse(java.lang.String id)
                                                           throws com.google.gerrit.extensions.restapi.UnprocessableEntityException
```
    Parses a group ID from a request body and returns the group.
    
    Parameters:
    id - ID of the group, can be a group UUID, a group name or a legacy group ID
    
    Returns:
    the group
    
    Throws:
    
    com.google.gerrit.extensions.restapi.UnprocessableEntityException - thrown if the group ID cannot be resolved or if the group is not visible to the calling user
  - parseInternal
```
public com.google.gerrit.common.data.GroupDescription.Basic parseInternal(java.lang.String id)
                                                                   throws com.google.gerrit.extensions.restapi.UnprocessableEntityException
```
    Parses a group ID from a request body and returns the group if it is a Gerrit internal group.
    
    Parameters:
    id - ID of the group, can be a group UUID, a group name or a legacy group ID
    
    Returns:
    the group
    
    Throws:
    
    com.google.gerrit.extensions.restapi.UnprocessableEntityException - thrown if the group ID cannot be resolved, if the group is not visible to the calling user or if it's an external group
  - parseId
```
public com.google.gerrit.common.data.GroupDescription.Basic parseId(java.lang.String id)
```
    Parses a group ID and returns the group without making any permission check whether the current user can see the group.
    
    Parameters:
    id - ID of the group, can be a group UUID, a group name or a legacy group ID
    
    Returns:
    the group, null if no group is found for the given group ID
  - create
```
public CreateGroup create(com.google.gerrit.extensions.restapi.TopLevelResource root,
                 com.google.gerrit.extensions.restapi.IdString name)
```
    Specified by:
    
    create in interface com.google.gerrit.extensions.restapi.AcceptsCreate<com.google.gerrit.extensions.restapi.TopLevelResource>
  - views
```
public com.google.gerrit.extensions.registration.DynamicMap<com.google.gerrit.extensions.restapi.RestView<GroupResource>> views()
```
    Specified by:
    
    views in interface com.google.gerrit.extensions.restapi.RestCollection<com.google.gerrit.extensions.restapi.TopLevelResource,GroupResource>

Class GroupsCollection

Method Summary

Methods inherited from class java.lang.Object

Method Detail

list

parse

parse

parseInternal

parseId

create

views