Class CascadeChoiceParameter

java.lang.Object

hudson.model.ParameterDefinition

hudson.model.SimpleParameterDefinition

org.biouno.unochoice.AbstractUnoChoiceParameter

org.biouno.unochoice.AbstractScriptableParameter

org.biouno.unochoice.AbstractCascadableParameter

org.biouno.unochoice.CascadeChoiceParameter

All Implemented Interfaces:

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

public class CascadeChoiceParameter
extends AbstractCascadableParameter

A choice parameter, that gets updated when another parameter changes. The simplest use case for this, would be having a list of states, and when the user selected a state it would trigger an update of the city fields.

The state parameter would be a choice parameter, and the city parameter would be a cascade choice parameter, that referenced the former.

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	CascadeChoiceParameter.DescriptImpl

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
CascadeChoiceParameter(String name, String description, String randomName, Script script, String choiceType, String referencedParameters, Boolean filterable)	Deprecated. see JENKINS-31625
CascadeChoiceParameter(String name, String description, String randomName, Script script, String choiceType, String referencedParameters, Boolean filterable, Integer filterLength)	Constructor called from Jelly with parameters.
CascadeChoiceParameter(String name, String description, Script script, String choiceType, String referencedParameters, Boolean filterable)	Deprecated. see JENKINS-32149

Method Summary

Modifier and Type	Method	Description
String	getChoiceType()	Gets the choice type.
boolean	getFilterable()	Get the filter flag.
Integer	getFilterLength()	Get the filter length.

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

CascadeChoiceParameter

@Deprecated
public CascadeChoiceParameter(String name,
 String description,
 Script script,
 String choiceType,
 String referencedParameters,
 Boolean filterable)

Deprecated.

see JENKINS-32149

Constructor called from Jelly with parameters.

Parameters:

name - name

description - description

script - script

choiceType - choice type

referencedParameters - referenced parameters

filterable - filter flag

CascadeChoiceParameter

@Deprecated
public CascadeChoiceParameter(String name,
 String description,
 String randomName,
 Script script,
 String choiceType,
 String referencedParameters,
 Boolean filterable)

Deprecated.

see JENKINS-31625

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

filterable - filter flag

CascadeChoiceParameter

@DataBoundConstructor
public CascadeChoiceParameter(String name,
 String description,
 String randomName,
 Script script,
 String choiceType,
 String referencedParameters,
 Boolean filterable,
 Integer filterLength)

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

filterable - filter flag

filterLength - filter length

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

getFilterable

public boolean getFilterable()

Get the filter flag.

Returns:

filter flag

getFilterLength

public Integer getFilterLength()

Get the filter length.

Returns:

filter length