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

Interface EnumParameter.Builder

All Superinterfaces:

EnumParameter.SetterBase, RichPageParameter.Builder<EnumParameter,EnumParameter.Builder>

Enclosing interface:

EnumParameter

public static interface EnumParameter.Builder
extends EnumParameter.SetterBase, RichPageParameter.Builder<EnumParameter,EnumParameter.Builder>

Method Summary

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

Methods inherited from interface com.polarion.alm.shared.api.model.rp.parameter.RichPageParameter.Builder

build, dependencySource, dependencyTarget

Method Details

loadForAllTypes

@NotNull
EnumParameter.Builder loadForAllTypes(boolean load)

Description copied from interface: EnumParameter.SetterBase

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

Specified by:

loadForAllTypes in interface EnumParameter.SetterBase

type

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

Specified by:

type in interface EnumParameter.SetterBase

scope

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

Description copied from interface: EnumParameter.SetterBase

Optionally select scope of the enumeration.

Specified by:

scope in interface EnumParameter.SetterBase

Parameters:

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

allowNoValue

@NotNull
EnumParameter.Builder allowNoValue(boolean allow)

Specified by:

allowNoValue in interface EnumParameter.SetterBase

allowMultipleValues

@NotNull
EnumParameter.Builder allowMultipleValues(boolean allow)

Specified by:

allowMultipleValues in interface EnumParameter.SetterBase

values

@NotNull
EnumParameter.Builder values(@Nullable
 Iterable<String> values)

Description copied from interface: EnumParameter.SetterBase

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

Specified by:

values in interface EnumParameter.SetterBase

Returns:

the same instance to allow method chaining.

values

@NotNull
EnumParameter.Builder values(@Nullable
 String... values)

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

Specified by:

values in interface EnumParameter.SetterBase

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

Since:

3.9.1

singleValue

@NotNull
EnumParameter.Builder singleValue(@Nullable
 String value)

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

Specified by:

singleValue in interface EnumParameter.SetterBase

Returns:

the same instance to allow method chaining.