Class DynamicReferenceParameter

java.lang.Object

hudson.model.ParameterDefinition

hudson.model.SimpleParameterDefinition

org.biouno.unochoice.AbstractUnoChoiceParameter

org.biouno.unochoice.AbstractScriptableParameter

org.biouno.unochoice.AbstractCascadableParameter

org.biouno.unochoice.DynamicReferenceParameter

All Implemented Interfaces:

ExtensionPoint, Describable<ParameterDefinition>, Serializable, CascadableParameter<Map<Object,Object>>, ScriptableParameter<Map<Object,Object>>, UnoChoiceParameter

public class DynamicReferenceParameter
extends AbstractCascadableParameter

Provides a dynamic reference parameter for users. This is a not so elegant solution, since we are using a ParameterDefinition extension point, but it actually doesn't provide any parameter value.

This kind of parameter is only for reference. An use case is when you have several job parameters, but your input values may vary depending on previous executions. You can get the previous executions by accessing from your Groovy code the jenkinsProject variable.

Its options are retrieved from the evaluation of a Groovy script.

Since:

0.1

Author:

Bruno P. Kinoshita

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	DynamicReferenceParameter.DescriptorImpl

Nested classes/interfaces inherited from class ParameterDefinition

ParameterDefinition.ParameterDescriptor

Nested classes/interfaces inherited from interface ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Field Summary

Fields inherited from class AbstractCascadableParameter

parameters

Fields inherited from class AbstractScriptableParameter

EQUALS, JENKINS_BUILD_VARIABLE_NAME, JENKINS_PARAMETER_VARIABLE_NAME, JENKINS_PROJECT_VARIABLE_NAME, script, SEPARATOR

Fields inherited from class AbstractUnoChoiceParameter

DEFAULT_MAX_VISIBLE_ITEM_COUNT, ELEMENT_TYPE_FORMATTED_HIDDEN_HTML, ELEMENT_TYPE_FORMATTED_HTML, ELEMENT_TYPE_ORDERED_LIST, ELEMENT_TYPE_TEXT_BOX, ELEMENT_TYPE_UNORDERED_LIST, LOGGER, PARAMETER_TYPE_CHECK_BOX, PARAMETER_TYPE_MULTI_SELECT, PARAMETER_TYPE_RADIO, PARAMETER_TYPE_SINGLE_SELECT

Fields inherited from class ParameterDefinition

LIST

Constructor Summary

Constructors

Constructor	Description
DynamicReferenceParameter(String name, String description, String randomName, Script script, String choiceType, String referencedParameters, Boolean omitValueField)	Constructor called from Jelly with parameters.
DynamicReferenceParameter(String name, String description, Script script, String choiceType, String referencedParameters, Boolean omitValueField)	Deprecated. see JENKINS-32149

Method Summary

Modifier and Type	Method	Description
String	getChoicesAsStringForUI()
String	getChoiceType()	Gets the choice type.
boolean	getOmitValueField()

Methods inherited from class AbstractCascadableParameter

doUpdate, getChoicesForUI, getParameters, getReferencedParameters, getReferencedParametersAsArray

Methods inherited from class AbstractScriptableParameter

detectProject, getCacheDefaultValue, getChoices, getChoices, getChoicesAsString, getChoicesAsString, getDefaultParameterValue, getItemCount, getScript, getVisibleItemCount, setCacheDefaultValue

Methods inherited from class AbstractUnoChoiceParameter

createValue, createValue, getDescriptor, getRandomName

Methods inherited from class SimpleParameterDefinition

createValue, createValue

Methods inherited from class ParameterDefinition

all, copyWithDefaultValue, createValue, createValue, equals, getDescription, getFormattedDescription, getName, getType, hashCode, isValid, setDescription

Methods inherited from class Object

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

Methods inherited from interface ScriptableParameter

getChoices

Constructor Details

DynamicReferenceParameter

@Deprecated
public DynamicReferenceParameter(String name,
 String description,
 Script script,
 String choiceType,
 String referencedParameters,
 Boolean omitValueField)

Deprecated.

see JENKINS-32149

Constructor called from Jelly with parameters.

Parameters:

name - name

description - description

script - script

choiceType - choice type

referencedParameters - referenced parameters

omitValueField - used in the UI to decide whether to include a hidden empty <input name=value>. false by default.

DynamicReferenceParameter

@DataBoundConstructor
public DynamicReferenceParameter(String name,
 String description,
 String randomName,
 Script script,
 String choiceType,
 String referencedParameters,
 Boolean omitValueField)

Constructor called from Jelly with parameters.

Parameters:

name - name

description - description

randomName - parameter random generated name (uuid)

script - script

choiceType - choice type

referencedParameters - referenced parameters

omitValueField - used in the UI to decide whether to include a hidden empty <input name=value>. false by default.

Method Details

getChoiceType

public String getChoiceType()

Description copied from class: AbstractUnoChoiceParameter

Gets the choice type.

This method can be called from Javascript

Specified by:

getChoiceType in class AbstractUnoChoiceParameter

Returns:

choice type

getOmitValueField

public boolean getOmitValueField()

getChoicesAsStringForUI

@JavaScriptMethod
public String getChoicesAsStringForUI()