Package com.google.gerrit.server.restapi.group

Class QueryGroups

java.lang.Object

com.google.gerrit.server.restapi.group.QueryGroups

All Implemented Interfaces:

RestReadView<TopLevelResource>, RestView<TopLevelResource>

public class QueryGroups
extends Object
implements RestReadView<TopLevelResource>

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	QueryGroups(GroupQueryBuilder queryBuilder, com.google.inject.Provider<GroupQueryProcessor> queryProcessorProvider, GroupJson json)

Method Summary

Modifier and Type	Method	Description
void	addOption(ListGroupsOption o)
Response<List<GroupInfo>>	apply(TopLevelResource resource)	Process the view operation by reading from the resource.
void	setLimit(int limit)
void	setOptionFlagsHex(String hex)
void	setQuery(String query)
void	setStart(int start)

Methods inherited from class java.lang.Object

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

Constructor Detail

QueryGroups

@Inject
protected QueryGroups(GroupQueryBuilder queryBuilder,
                      com.google.inject.Provider<GroupQueryProcessor> queryProcessorProvider,
                      GroupJson json)

Method Detail

setQuery

public void setQuery(String query)

setLimit

public void setLimit(int limit)

setStart

public void setStart(int start)

addOption

public void addOption(ListGroupsOption o)

setOptionFlagsHex

public void setOptionFlagsHex(String hex)
                       throws BadRequestException

Throws:

BadRequestException

apply

public Response<List<GroupInfo>> apply(TopLevelResource resource)
                                throws BadRequestException,
                                       MethodNotAllowedException,
                                       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:

resource - resource to read

Returns:

response to return to the client

Throws:

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

MethodNotAllowedException

PermissionBackendException