Package com.google.gerrit.server.restapi.account

Interface AccountsCollection

All Superinterfaces:

RestCollection<TopLevelResource,AccountResource>

All Known Implementing Classes:

AccountsCollectionImpl

public interface AccountsCollection
extends RestCollection<TopLevelResource,AccountResource>

A generic interface for parsing account IDs from URL resources.

Method Summary

Modifier and Type	Method	Description
RestView<TopLevelResource>	list()	Create a view to list the contents of the collection.
AccountResource	parse(TopLevelResource root, IdString id)	Parse a path component into a resource handle.
DynamicMap<RestView<AccountResource>>	views()	Get the views that support this collection.

Method Details

parse

AccountResource parse(TopLevelResource root,
 IdString id)
               throws ResourceNotFoundException,
AuthException,
IOException,
org.eclipse.jgit.errors.ConfigInvalidException

Description copied from interface: RestCollection

Parse a path component into a resource handle.

Specified by:

parse in interface RestCollection<TopLevelResource,AccountResource>

Parameters:

root - the handle to the collection.

id - string identifier supplied by the client. In a URL such as /changes/1234/abandon this string is "1234".

Returns:

a resource handle for the identified object.

Throws:

ResourceNotFoundException - the object does not exist, or the caller is not permitted to know if the resource exists.

AuthException

IOException

org.eclipse.jgit.errors.ConfigInvalidException

list

RestView<TopLevelResource> list()
                         throws ResourceNotFoundException

Description copied from interface: RestCollection

Create a view to list the contents of the collection.

The returned view should accept the parent type to scope the search, and may want to take a "q" parameter option to narrow the results.

Specified by:

list in interface RestCollection<TopLevelResource,AccountResource>

Returns:

view to list the collection.

Throws:

ResourceNotFoundException - if the collection doesn't support listing.

views

DynamicMap<RestView<AccountResource>> views()

Description copied from interface: RestCollection

Get the views that support this collection.

Within a resource the views are accessed as RESOURCE/plugin~view.

Specified by:

views in interface RestCollection<TopLevelResource,AccountResource>

Returns:

map of views.