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

Class DeleteSubmitRequirement

java.lang.Object

com.google.gerrit.server.restapi.project.DeleteSubmitRequirement

All Implemented Interfaces:

RestModifyView<SubmitRequirementResource,Input>, RestView<SubmitRequirementResource>

public class DeleteSubmitRequirement
extends Object
implements RestModifyView<SubmitRequirementResource,Input>

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
Response<?>	apply(SubmitRequirementResource rsrc, Input input)	Process the view operation by altering the resource.
boolean	deleteSubmitRequirement(ProjectConfig config, String srName)	Delete the given submit requirement from the project config.

Methods inherited from class java.lang.Object

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

Constructor Detail

DeleteSubmitRequirement

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

Method Detail

apply

public Response<?> apply(SubmitRequirementResource rsrc,
                         Input input)
                  throws Exception

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

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.

ResourceConflictException - the resource state does not permit this view to make the changes at this time.

Exception - the implementation of the view failed. The exception will be logged and HTTP 500 Internal Server Error will be returned to the client.

deleteSubmitRequirement

public boolean deleteSubmitRequirement(ProjectConfig config,
                                       String srName)

Delete the given submit requirement from the project config.

Parameters:

config - the project config from which the submit-requirement should be deleted

srName - the name of the submit requirement that should be deleted

Returns:

true if the submit-requirement was deleted, false if the submit-requirement was not found