com.google.gerrit.server.restapi.change

Class PutDescription

java.lang.Object

com.google.gerrit.server.update.RetryingRestModifyView<RevisionResource,DescriptionInput,Response<java.lang.String>>

com.google.gerrit.server.restapi.change.PutDescription

All Implemented Interfaces:

RestModifyView<RevisionResource,DescriptionInput>, RestView<RevisionResource>, UiAction<RevisionResource>

public class PutDescription
extends RetryingRestModifyView<RevisionResource,DescriptionInput,Response<java.lang.String>>
implements UiAction<RevisionResource>

Nested Class Summary

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

UiAction.Description

Method Summary

Modifier and Type	Method and Description
protected Response<java.lang.String>	applyImpl(BatchUpdate.Factory updateFactory, RevisionResource rsrc, DescriptionInput input)
UiAction.Description	getDescription(RevisionResource rsrc) Get the description of the action customized for the resource.

Methods inherited from class com.google.gerrit.server.update.RetryingRestModifyView

apply

Methods inherited from class java.lang.Object

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

Method Detail

applyImpl

protected Response<java.lang.String> applyImpl(BatchUpdate.Factory updateFactory,
                                               RevisionResource rsrc,
                                               DescriptionInput input)
                                        throws UpdateException,
                                               RestApiException,
                                               PermissionBackendException

Specified by:

applyImpl in class RetryingRestModifyView<RevisionResource,DescriptionInput,Response<java.lang.String>>

Throws:

UpdateException

RestApiException

PermissionBackendException

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