Package org.biouno.unochoice
Class 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 class
DynamicReferenceParameter.DescriptorImpl
-
Nested classes/interfaces inherited from class hudson.model.ParameterDefinition
ParameterDefinition.ParameterDescriptor
-
Nested classes/interfaces inherited from interface hudson.ExtensionPoint
ExtensionPoint.LegacyInstancesAreScopedToHudson
-
-
Field Summary
-
Fields inherited from class org.biouno.unochoice.AbstractCascadableParameter
parameters
-
Fields inherited from class org.biouno.unochoice.AbstractScriptableParameter
EQUALS, JENKINS_BUILD_VARIABLE_NAME, JENKINS_PARAMETER_VARIABLE_NAME, JENKINS_PROJECT_VARIABLE_NAME, script, SEPARATOR
-
Fields inherited from class org.biouno.unochoice.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 hudson.model.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
All Methods Instance Methods Concrete Methods Modifier and Type Method Description String
getChoicesAsStringForUI()
String
getChoiceType()
Gets the choice type.Boolean
getOmitValueField()
-
Methods inherited from class org.biouno.unochoice.AbstractCascadableParameter
doUpdate, getChoicesForUI, getParameters, getReferencedParameters, getReferencedParametersAsArray
-
Methods inherited from class org.biouno.unochoice.AbstractScriptableParameter
getChoices, getChoices, getChoicesAsString, getChoicesAsString, getDefaultParameterValue, getScript, getVisibleItemCount
-
Methods inherited from class org.biouno.unochoice.AbstractUnoChoiceParameter
all, createValue, createValue, getDescriptor, getRandomName
-
Methods inherited from class hudson.model.SimpleParameterDefinition
createValue, createValue
-
Methods inherited from class hudson.model.ParameterDefinition
copyWithDefaultValue, getDescription, getFormattedDescription, getName, getType
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface org.biouno.unochoice.ScriptableParameter
getChoices
-
-
-
-
Constructor Detail
-
DynamicReferenceParameter
public DynamicReferenceParameter(String name, String description, Script script, String choiceType, String referencedParameters, Boolean omitValueField)
Deprecated.see JENKINS-32149Constructor called from Jelly with parameters.- Parameters:
name
- namedescription
- descriptionscript
- scriptchoiceType
- choice typereferencedParameters
- referenced parametersomitValueField
- 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
- namedescription
- descriptionrandomName
- parameter random generated name (uuid)script
- scriptchoiceType
- choice typereferencedParameters
- referenced parametersomitValueField
- used in the UI to decide whether to include a hidden empty <input name=value>.false
by default.
-
-
Method Detail
-
getChoiceType
public String getChoiceType()
Description copied from class:AbstractUnoChoiceParameter
Gets the choice type.
This method can be called from Javascript
- Specified by:
getChoiceType
in classAbstractUnoChoiceParameter
- Returns:
- choice type
-
getOmitValueField
public Boolean getOmitValueField()
-
getChoicesAsStringForUI
@JavaScriptMethod public String getChoicesAsStringForUI()
-
-