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

Interface EnumParameter.SetterBase

All Known Subinterfaces:

EnumParameter.Builder, EnumParameter.Setter

Enclosing interface:

EnumParameter

public static interface EnumParameter.SetterBase

Since:

3.9.2

Method Summary

Modifier and Type	Method	Description
EnumParameter.SetterBase	allowMultipleValues(boolean allow)
EnumParameter.SetterBase	allowNoValue(boolean allow)
EnumParameter.SetterBase	loadForAllTypes(boolean load)	Configures to load enumeration options for all work item types. Default value is true.
EnumParameter.SetterBase	scope(Scope scope)	Optionally select scope of the enumeration.
EnumParameter.SetterBase	singleValue(String value)	Overrides values set by values(String...) or values(String...) methods.
EnumParameter.SetterBase	type(String type)
EnumParameter.SetterBase	values(Iterable<String> values)	Overrides values set by values(String...) or singleValue(String) methods.
EnumParameter.SetterBase	values(String... values)	Overrides values set by values(Iterable) or singleValue(String) methods.

Method Details

type

@NotNull
EnumParameter.SetterBase type(@Nullable
 String type)

loadForAllTypes

@NotNull
EnumParameter.SetterBase loadForAllTypes(boolean load)

Configures to load enumeration options for all work item types.
Default value is true.

scope

@NotNull
EnumParameter.SetterBase scope(@Nullable
 Scope scope)

Optionally select scope of the enumeration.

Parameters:

scope - - null means the same as when the method is not called at all = current scope is used

allowNoValue

@NotNull
EnumParameter.SetterBase allowNoValue(boolean allow)

allowMultipleValues

@NotNull
EnumParameter.SetterBase allowMultipleValues(boolean allow)

Throws:

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

values

@NotNull
EnumParameter.SetterBase 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
EnumParameter.SetterBase 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
EnumParameter.SetterBase singleValue(@Nullable
 String value)

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

Returns:

the same instance to allow method chaining.