Package com.google.gerrit.server.restapi.change

Class QueryChanges

java.lang.Object

com.google.gerrit.server.restapi.change.QueryChanges

All Implemented Interfaces:

RestReadView<TopLevelResource>, RestView<TopLevelResource>, DynamicOptions.BeanReceiver

public class QueryChanges
extends Object
implements RestReadView<TopLevelResource>, DynamicOptions.BeanReceiver

Method Summary

Modifier and Type	Method	Description
void	addOption(ListChangesOption o)
void	addQuery(String query)
Response<List<?>>	apply(TopLevelResource rsrc)	Process the view operation by reading from the resource.
String	getQuery(int i)
void	setAllowIncompleteResults(boolean allowIncompleteResults)
void	setDynamicBean(String plugin, DynamicOptions.DynamicBean dynamicBean)
void	setLimit(int limit)
void	setNoLimit(boolean on)
void	setStart(int start)
void	skipVisibility(boolean on)

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.google.gerrit.server.DynamicOptions.BeanReceiver

getExportedBeanReceiver

Method Details

setLimit

public void setLimit(int limit)

addOption

public void addOption(ListChangesOption o)

setStart

public void setStart(int start)

setNoLimit

public void setNoLimit(boolean on)

skipVisibility

public void skipVisibility(boolean on)
                    throws AuthException,
PermissionBackendException

Throws:

AuthException

PermissionBackendException

setAllowIncompleteResults

public void setAllowIncompleteResults(boolean allowIncompleteResults)

setDynamicBean

public void setDynamicBean(String plugin,
 DynamicOptions.DynamicBean dynamicBean)

Specified by:

setDynamicBean in interface DynamicOptions.BeanReceiver

addQuery

public void addQuery(String query)

getQuery

public String getQuery(int i)

apply

public Response<List<?>> apply(TopLevelResource rsrc)
                        throws BadRequestException,
AuthException,
PermissionBackendException

Description copied from interface: RestReadView

Process the view operation by reading from the resource.

The value of the returned response is automatically converted to JSON unless it is a BinaryResult.

The returned response defines the status code that is returned to the client. For RestReadViews this is usually 200 OK, but other 2XX or 3XX status codes are also possible (e.g. Response.Redirect can be returned for 302 Found).

Throwing a subclass of RestApiException results in a 4XX response to the client. For any other exception the client will get a 500 Internal Server Error response.

Specified by:

apply in interface RestReadView<TopLevelResource>

Parameters:

rsrc - resource to read

Returns:

response to return to the client

Throws:

BadRequestException - the request was incorrectly specified and cannot be handled by this view.

AuthException - the caller is not permitted to access this view.

PermissionBackendException