Package com.google.gerrit.server.restapi.project

Class UpdateSubmitRequirement

java.lang.Object

com.google.gerrit.server.restapi.project.UpdateSubmitRequirement

All Implemented Interfaces:

RestModifyView<SubmitRequirementResource,SubmitRequirementInput>, RestView<SubmitRequirementResource>

public class UpdateSubmitRequirement
extends Object
implements RestModifyView<SubmitRequirementResource,SubmitRequirementInput>

A rest modify view that updates the definition of an existing submit requirement for a project.

Constructor Summary

Constructors

Constructor	Description
UpdateSubmitRequirement(com.google.inject.Provider<CurrentUser> user, PermissionBackend permissionBackend, MetaDataUpdate.User updateFactory, ProjectConfig.Factory projectConfigFactory, ProjectCache projectCache, SubmitRequirementExpressionsValidator submitRequirementExpressionsValidator)

Method Summary

Modifier and Type	Method	Description
Response<SubmitRequirementInfo>	apply(SubmitRequirementResource rsrc, SubmitRequirementInput input)	Process the view operation by altering the resource.
SubmitRequirement	createSubmitRequirement(ProjectConfig config, String name, SubmitRequirementInput input)

Methods inherited from class java.lang.Object

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

Constructor Detail

UpdateSubmitRequirement

@Inject
public UpdateSubmitRequirement(com.google.inject.Provider<CurrentUser> user,
                               PermissionBackend permissionBackend,
                               MetaDataUpdate.User updateFactory,
                               ProjectConfig.Factory projectConfigFactory,
                               ProjectCache projectCache,
                               SubmitRequirementExpressionsValidator submitRequirementExpressionsValidator)

Method Detail

apply

public Response<SubmitRequirementInfo> apply(SubmitRequirementResource rsrc,
                                             SubmitRequirementInput input)
                                      throws AuthException,
                                             BadRequestException,
                                             PermissionBackendException,
                                             IOException

Description copied from interface: RestModifyView

Process the view operation by altering 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 RestModifyViews this is usually 200 OK, but other 2XX or 3XX status codes are also possible (e.g. 202 Accepted if a background task was scheduled, 204 No Content if no content is returned, 302 Found for a redirect).

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 RestModifyView<SubmitRequirementResource,SubmitRequirementInput>

Parameters:

rsrc - resource to modify

input - input after parsing from request

Returns:

response to return to the client

Throws:

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

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

PermissionBackendException

IOException

createSubmitRequirement

public SubmitRequirement createSubmitRequirement(ProjectConfig config,
                                                 String name,
                                                 SubmitRequirementInput input)
                                          throws BadRequestException

Throws:

BadRequestException