Package com.polarion.alm.shared.api.model.rp.parameter

Interface CustomEnumParameter.Setter

All Known Subinterfaces:

CustomEnumParameter.Builder

Enclosing interface:

CustomEnumParameter

public static interface CustomEnumParameter.Setter

Method Summary

Modifier and Type	Method	Description
CustomEnumParameter.Setter	addEnumItem(String value, String label)	Adds an enumeration item.
CustomEnumParameter.Setter	allowMultipleValues(boolean value)
CustomEnumParameter.Setter	allowNoValue(boolean allow)	Adds 'not selected' option.
CustomEnumParameter.Setter	clear()	Removes all enumeration items.
CustomEnumParameter.Setter	singleValue(String value)	Overrides values set by values(Iterable) or values(String...) methods.
CustomEnumParameter.Setter	tooltip(String value)	Sets a tooltip for an item.
CustomEnumParameter.Setter	values(Iterable<String> values)	Overrides values set by values(String...) or singleValue(String) methods.
CustomEnumParameter.Setter	values(String... values)	Overrides values set by values(Iterable) or singleValue(String) methods.

Method Details

addEnumItem

@NotNull
CustomEnumParameter.Setter addEnumItem(@NotNull
 String value,
 @Nullable
 String label)

Adds an enumeration item.

Parameters:

value - id of the option, selected value will be returned in CustomEnumParameter.values()

label - that will be shown to user, if label is null, value will be used as label

Returns:

the same instance to allow method chaining.

tooltip

@NotNull
CustomEnumParameter.Setter tooltip(@NotNull
 String value)

Sets a tooltip for an item.

Parameters:

value - The tooltip text to use for the item.

Returns:

the same instance to allow method chaining.

Since:

3.25.6

clear

@NotNull
CustomEnumParameter.Setter clear()

Removes all enumeration items.

Returns:

the same instance to allow method chaining.

allowNoValue

@NotNull
CustomEnumParameter.Setter allowNoValue(boolean allow)

Adds 'not selected' option.

allowMultipleValues

@NotNull
CustomEnumParameter.Setter allowMultipleValues(boolean value)

Throws:

IllegalArgumentException - if there are more than one values already set by values(Iterable) or values(String...) and the value is false

values

@NotNull
CustomEnumParameter.Setter values(@Nullable
 Iterable<String> values)

Overrides values set by values(String...) or singleValue(String) methods.

Returns:

the same instance to allow method chaining.

Throws:

IllegalArgumentException - if this parameter does not allow multiple values and the parameter contains more then one value

values

@NotNull
CustomEnumParameter.Setter values(@Nullable
 String... values)

Overrides values set by values(Iterable) or singleValue(String) methods.

Returns:

the same instance to allow method chaining.

Throws:

IllegalArgumentException - if this parameter does not allow multiple values and the parameter contains more then one value

singleValue

@NotNull
CustomEnumParameter.Setter singleValue(@Nullable
 String value)

Overrides values set by values(Iterable) or values(String...) methods.

Returns:

the same instance to allow method chaining.