AccountsCollection (Gerrit Review Plugin API Documentation)

java.lang.Object
- com.google.gerrit.server.account.AccountsCollection

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,AccountResource>

public class AccountsCollection
extends Object
implements com.google.gerrit.extensions.restapi.RestCollection<com.google.gerrit.extensions.restapi.TopLevelResource,AccountResource>, com.google.gerrit.extensions.restapi.AcceptsCreate<com.google.gerrit.extensions.restapi.TopLevelResource>

Method Summary

Methods
Modifier and Type	Method and Description
`CreateAccount`	`create(com.google.gerrit.extensions.restapi.TopLevelResource parent, com.google.gerrit.extensions.restapi.IdString username)`
`com.google.gerrit.extensions.restapi.RestView<com.google.gerrit.extensions.restapi.TopLevelResource>`	`list()`
`IdentifiedUser`	`parse(String id)` Parses a account ID from a request body and returns the user.
`AccountResource`	`parse(com.google.gerrit.extensions.restapi.TopLevelResource root, com.google.gerrit.extensions.restapi.IdString id)`
`IdentifiedUser`	`parseId(String id)` Parses an account ID and returns the user without making any permission check whether the current user can see the account.
`com.google.gerrit.extensions.registration.DynamicMap<com.google.gerrit.extensions.restapi.RestView<AccountResource>>`	`views()`

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

- Method Detail
  - parse
```
public AccountResource parse(com.google.gerrit.extensions.restapi.TopLevelResource root,
                    com.google.gerrit.extensions.restapi.IdString id)
                      throws com.google.gerrit.extensions.restapi.ResourceNotFoundException,
                             com.google.gerrit.extensions.restapi.AuthException,
                             com.google.gwtorm.server.OrmException
```
    Specified by:
    
    parse in interface com.google.gerrit.extensions.restapi.RestCollection<com.google.gerrit.extensions.restapi.TopLevelResource,AccountResource>
    
    Throws:
    
    com.google.gerrit.extensions.restapi.ResourceNotFoundException
    
    com.google.gerrit.extensions.restapi.AuthException
    
    com.google.gwtorm.server.OrmException
  - parse
```
public IdentifiedUser parse(String id)
                     throws com.google.gerrit.extensions.restapi.AuthException,
                            com.google.gerrit.extensions.restapi.UnprocessableEntityException,
                            com.google.gwtorm.server.OrmException
```
    Parses a account ID from a request body and returns the user.
    
    Parameters:
    id - ID of the account, can be a string of the format "Full Name <[email protected]>", just the email address, a full name if it is unique, an account ID, a user name or "self" for the calling user
    
    Returns:
    the user, never null.
    
    Throws:
    
    com.google.gerrit.extensions.restapi.UnprocessableEntityException - thrown if the account ID cannot be resolved or if the account is not visible to the calling user
    
    com.google.gerrit.extensions.restapi.AuthException
    
    com.google.gwtorm.server.OrmException
  - parseId
```
public IdentifiedUser parseId(String id)
                       throws com.google.gerrit.extensions.restapi.AuthException,
                              com.google.gwtorm.server.OrmException
```
    Parses an account ID and returns the user without making any permission check whether the current user can see the account.
    
    Parameters:
    id - ID of the account, can be a string of the format "Full Name <[email protected]>", just the email address, a full name if it is unique, an account ID, a user name or "self" for the calling user
    
    Returns:
    the user, null if no user is found for the given account ID
    
    Throws:
    
    com.google.gerrit.extensions.restapi.AuthException - thrown if 'self' is used as account ID and the current user is not authenticated
    
    com.google.gwtorm.server.OrmException
  - list
```
public com.google.gerrit.extensions.restapi.RestView<com.google.gerrit.extensions.restapi.TopLevelResource> list()
                                                                                                          throws com.google.gerrit.extensions.restapi.ResourceNotFoundException
```
    Specified by:
    
    list in interface com.google.gerrit.extensions.restapi.RestCollection<com.google.gerrit.extensions.restapi.TopLevelResource,AccountResource>
    
    Throws:
    
    com.google.gerrit.extensions.restapi.ResourceNotFoundException
  - views
```
public com.google.gerrit.extensions.registration.DynamicMap<com.google.gerrit.extensions.restapi.RestView<AccountResource>> views()
```
    Specified by:
    
    views in interface com.google.gerrit.extensions.restapi.RestCollection<com.google.gerrit.extensions.restapi.TopLevelResource,AccountResource>
  - create
```
public CreateAccount create(com.google.gerrit.extensions.restapi.TopLevelResource parent,
                   com.google.gerrit.extensions.restapi.IdString username)
```
    Specified by:
    
    create in interface com.google.gerrit.extensions.restapi.AcceptsCreate<com.google.gerrit.extensions.restapi.TopLevelResource>

Class AccountsCollection

Method Summary

Methods inherited from class java.lang.Object

Method Detail

parse

parse

parseId

list

views

create