com.google.gerrit.server.change

Class ChangesCollection

java.lang.Object

com.google.gerrit.server.change.ChangesCollection

All Implemented Interfaces:

AcceptsPost<TopLevelResource>, RestCollection<TopLevelResource,ChangeResource>

public class ChangesCollection
extends java.lang.Object
implements RestCollection<TopLevelResource,ChangeResource>, AcceptsPost<TopLevelResource>

Method Summary

Modifier and Type	Method and Description
QueryChanges	list() Create a view to list the contents of the collection.
ChangeResource	parse(Change.Id id)
ChangeResource	parse(ChangeNotes notes, CurrentUser user)
ChangeResource	parse(TopLevelResource root, IdString id) Parse a path component into a resource handle.
CreateChange	post(TopLevelResource parent) Handle creation of a child resource by POST on the collection.
DynamicMap<RestView<ChangeResource>>	views() Get the views that support this collection.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

list

public QueryChanges list()

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

Returns:

view to list the collection.

views

public DynamicMap<RestView<ChangeResource>> 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,ChangeResource>

Returns:

map of views.

parse

public ChangeResource parse(TopLevelResource root,
                            IdString id)
                     throws ResourceNotFoundException,
                            com.google.gwtorm.server.OrmException,
                            PermissionBackendException

Description copied from interface: RestCollection

Parse a path component into a resource handle.

Specified by:

parse in interface RestCollection<TopLevelResource,ChangeResource>

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.

com.google.gwtorm.server.OrmException

PermissionBackendException

parse

public ChangeResource parse(Change.Id id)
                     throws ResourceNotFoundException,
                            com.google.gwtorm.server.OrmException,
                            PermissionBackendException

Throws:

ResourceNotFoundException

com.google.gwtorm.server.OrmException

PermissionBackendException

parse

public ChangeResource parse(ChangeNotes notes,
                            CurrentUser user)

post

public CreateChange post(TopLevelResource parent)
                  throws RestApiException

Description copied from interface: AcceptsPost

Handle creation of a child resource by POST on the collection.

Specified by:

post in interface AcceptsPost<TopLevelResource>

Parameters:

parent - parent collection handle.

Returns:

a view to perform the creation. The id of the newly created resource should be determined from the input body.

Throws:

RestApiException - the view cannot be constructed.