Package io.jenkins.plugins.restlistparam

Class ValueLoader

java.lang.Object

io.jenkins.plugins.restlistparam.ValueLoader

public final class ValueLoader
extends Object

Loads the entries of one rendered parameter for the build form. The view binds it to the page with <st:bind>, so it holds the exact definition instance that was rendered (for example the Rebuild copy with the previous value as default) and the job the form belongs to.

Method Summary

Modifier and Type	Method	Description
net.sf.json.JSONObject	load(boolean forced)	Returns the parameter's entries, or the error of fetching them.

Methods inherited from class java.lang.Object

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

Method Details

load

@JavaScriptMethod
public net.sf.json.JSONObject load(boolean forced)

Returns the parameter's entries, or the error of fetching them. Requires Build on the job, or Administer when there is no job. Request details of a failed fetch are only included for callers who may configure the job.

 { "status": "ok", "entries": [ { "value", "display", "selected" } ],
   "freeTextValue": "...",           // REST List Parameter with validation disabled
   "unmatchedDefaults": [ "..." ] }  // REST Multi List Parameter with validation disabled
 { "status": "error", "message": "...",
   "details": { "url", "page", "cause", "durationMs" } }  // Configure only
 

Parameters:

forced - Whether to bypass the value cache and the HTTP response cache