com.google.gerrit.server.change

Class PutDescription

java.lang.Object

com.google.gerrit.server.change.PutDescription

All Implemented Interfaces:

RestModifyView<RevisionResource,PutDescription.Input>, RestView<RevisionResource>, UiAction<RevisionResource>

public class PutDescription
extends java.lang.Object
implements RestModifyView<RevisionResource,PutDescription.Input>, UiAction<RevisionResource>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PutDescription.Input

Nested classes/interfaces inherited from interface com.google.gerrit.extensions.webui.UiAction

UiAction.Description

Method Summary

Modifier and Type	Method and Description
Response<java.lang.String>	apply(RevisionResource rsrc, PutDescription.Input input) Process the view operation by altering the resource.
UiAction.Description	getDescription(RevisionResource rsrc) Get the description of the action customized for the resource.

Methods inherited from class java.lang.Object

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

Method Detail

apply

public Response<java.lang.String> apply(RevisionResource rsrc,
                                        PutDescription.Input input)
                                 throws UpdateException,
                                        RestApiException

Description copied from interface: RestModifyView

Process the view operation by altering the resource.

Specified by:

apply in interface RestModifyView<RevisionResource,PutDescription.Input>

Parameters:

rsrc - resource to modify.

input - input after parsing from request.

Returns:

result to return to the client. Use BinaryResult to avoid automatic conversion to JSON.

Throws:

AuthException - the client 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.

UpdateException

RestApiException

getDescription

public UiAction.Description getDescription(RevisionResource rsrc)

Description copied from interface: UiAction

Get the description of the action customized for the resource.

Specified by:

getDescription in interface UiAction<RevisionResource>

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).