Package io.jenkins.plugins.batchcontrol.action

Class RunApprovalNoticeAction

java.lang.Object

io.jenkins.plugins.batchcontrol.action.RunApprovalNoticeAction

All Implemented Interfaces:

Action, ModelObject

@Restricted(org.kohsuke.accmod.restrictions.NoExternalUse.class)
public class RunApprovalNoticeAction
extends Object
implements Action

The build-page counterpart of the job-page approval notice (SPEC item 6, e2e re-audit DEF-31): on every build of a job whose manual runs need an approved run request, the build page says so and links the run request form for a viewer who may submit it. Rebuild and Retry are clicked on the build page and a refusal there only produces core's generic "Failed." message, so the explanation has to be where the button is.

Attached by RunApprovalNoticeActionFactory. No sidebar entry and no URL; its summary.jelly is included by the build page. Every decision is delegated to the job's JobActivationNoticeAction, so the two notices cannot disagree: shown only to Item/Read holders while run control is on and the job requires approval; the form is linked only for a viewer who may submit a run request (BatchControl/Request and Item/Read, D-38a). It never changes state.

Constructor Summary

Constructors

Constructor	Description
RunApprovalNoticeAction(Run<?,?> run)

Method Summary

Modifier and Type	Method	Description
String	getDisplayName()
String	getIconFileName()
Job<?,?>	getJob()
String	getUrlName()
boolean	isCanRequest()	Whether the viewer holds BatchControl/Request.
boolean	isCanRequestRun()	Whether the run request form is linked (JobActivationNoticeAction.isCanRequestRun()).
boolean	isShown()	Whether the notice is rendered (see JobActivationNoticeAction.isApprovalRequired()).

Methods inherited from class java.lang.Object

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

Methods inherited from interface hudson.model.Action

getDescription, getEvent, getGroup, getSemantic, isVisibleInContextMenu

Constructor Details

RunApprovalNoticeAction

public RunApprovalNoticeAction(Run<?,?> run)

Method Details

getJob

public Job<?,?> getJob()

isShown

public boolean isShown()

Whether the notice is rendered (see JobActivationNoticeAction.isApprovalRequired()).

isCanRequestRun

public boolean isCanRequestRun()

Whether the run request form is linked (JobActivationNoticeAction.isCanRequestRun()).

isCanRequest

public boolean isCanRequest()

Whether the viewer holds BatchControl/Request.

getIconFileName

@CheckForNull
public String getIconFileName()

Specified by:

getIconFileName in interface Action

getDisplayName

public String getDisplayName()

Specified by:

getDisplayName in interface Action

Specified by:

getDisplayName in interface ModelObject

getUrlName

@CheckForNull
public String getUrlName()

Specified by:

getUrlName in interface Action