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

Class SetWorkInProgress

java.lang.Object
com.google.gerrit.server.restapi.change.SetWorkInProgress
All Implemented Interfaces:
RestModifyView<ChangeResource,WorkInProgressOp.Input>, RestView<ChangeResource>, UiAction<ChangeResource>
public class SetWorkInProgress extends Object implements RestModifyView<ChangeResource,WorkInProgressOp.Input>, UiAction<ChangeResource>

  • Method Details

    • apply

      public Response<String> apply(ChangeResource rsrc, WorkInProgressOp.Input input) throws RestApiException, UpdateException, PermissionBackendException
      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<ChangeResource,WorkInProgressOp.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.
      RestApiException
      UpdateException
      PermissionBackendException

    • getDescription

      public UiAction.Description getDescription(ChangeResource rsrc)
      Description copied from interface: UiAction
      Get the description of the action customized for the resource.
      Specified by:
      getDescription in interface UiAction<ChangeResource>
      Parameters:
      rsrc - the resource the view would act upon if the action is invoked by the client. Information from the resource can be used to customize the description.
      Returns:
      a description of the action. The server will populate the id and method properties. If null the action will assumed unavailable and not presented. This is usually the same as setVisible(false).