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

Interface DataSetParameter.Builder

All Superinterfaces:

CompositeParameter.BuilderBase<DataSetParameter,DataSetParameter.Builder>, DataSetParameter.Setter, RichPageParameter.Builder<DataSetParameter,DataSetParameter.Builder>

Enclosing interface:

DataSetParameter

public static interface DataSetParameter.Builder
extends DataSetParameter.Setter, CompositeParameter.BuilderBase<DataSetParameter,DataSetParameter.Builder>

Method Summary

Modifier and Type	Method	Description
DataSetParameter.Builder	add(String id, RichPageParameter parameter)
DataSetParameter.Builder	allowCollectionScope(boolean allowCollectionScope)
DataSetParameter.Builder	allowedPrototypes(PrototypeEnum firstAllowed, PrototypeEnum... otherAllowed)	Sets which prototypes will be selectable by a user and overrides the values set by DataSetParameter.Setter.allowedPrototypes(Iterable).
DataSetParameter.Builder	allowedPrototypes(Iterable<String> allowedPrototypes)	Sets which prototypes will be selectable by a user and overrides the values set by DataSetParameter.Setter.allowedPrototypes(PrototypeEnum, PrototypeEnum...) If the allowed prototypes do not contain the target prototype then the first allowed prototype is automatically selected as the target prototype.
DataSetParameter.Builder	lucenePlusVelocityQuery(String value)
DataSetParameter.Builder	luceneQuery(String value)
PrototypeSelector<DataSetParameter.Builder>	prototype()	Clears the subtype defined by DataSetParameter.Setter.subtype(String), so it must be used before using DataSetParameter.Setter.subtype(String).
ScopeSelector<DataSetParameter.Builder>	scope()	Current scope is used when this method is NOT called.
DataSetParameter.Builder	sqlPlusVelocityQuery(String columnsQuery, String tablesQuery, String restQuery)
DataSetParameter.Builder	sqlQuery(String columnsQuery, String tablesQuery, String restQuery)
DataSetParameter.Builder	subtype(String value)	Must be used after DataSetParameter.Setter.prototype(), otherwise the value is lost.

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

build, dependencySource, dependencyTarget

Method Details

scope

@NotNull
ScopeSelector<DataSetParameter.Builder> scope()

Description copied from interface: DataSetParameter.Setter

Current scope is used when this method is NOT called.

Specified by:

scope in interface DataSetParameter.Setter

prototype

@NotNull
PrototypeSelector<DataSetParameter.Builder> prototype()

Description copied from interface: DataSetParameter.Setter

Clears the subtype defined by DataSetParameter.Setter.subtype(String), so it must be used before using DataSetParameter.Setter.subtype(String). If the prototype is not contained in the allowed prototypes (specified with DataSetParameter.Setter.allowedPrototypes(PrototypeEnum, PrototypeEnum...). or DataSetParameter.Setter.allowedPrototypes(Iterable) ) then it is added automatically.

Specified by:

prototype in interface DataSetParameter.Setter

subtype

@NotNull
DataSetParameter.Builder subtype(@Nullable
 String value)

Description copied from interface: DataSetParameter.Setter

Must be used after DataSetParameter.Setter.prototype(), otherwise the value is lost.

Specified by:

subtype in interface DataSetParameter.Setter

luceneQuery

@NotNull
DataSetParameter.Builder luceneQuery(@Nullable
 String value)

Specified by:

luceneQuery in interface DataSetParameter.Setter

lucenePlusVelocityQuery

@NotNull
DataSetParameter.Builder lucenePlusVelocityQuery(@Nullable
 String value)

Specified by:

lucenePlusVelocityQuery in interface DataSetParameter.Setter

sqlQuery

@NotNull
DataSetParameter.Builder sqlQuery(@Nullable
 String columnsQuery,
 @Nullable
 String tablesQuery,
 @Nullable
 String restQuery)

Specified by:

sqlQuery in interface DataSetParameter.Setter

sqlPlusVelocityQuery

@NotNull
DataSetParameter.Builder sqlPlusVelocityQuery(@Nullable
 String columnsQuery,
 @Nullable
 String tablesQuery,
 @Nullable
 String restQuery)

Specified by:

sqlPlusVelocityQuery in interface DataSetParameter.Setter

add

@NotNull
DataSetParameter.Builder add(@NotNull
 String id,
 @NotNull
 RichPageParameter parameter)

Specified by:

add in interface CompositeParameter.BuilderBase<DataSetParameter,DataSetParameter.Builder>

Parameters:

id - - Must not contain the dot ('.') character.

Throws:

IllegalArgumentException - When the parameter with the given id was already added or when it contains the dot ('.') character.

IllegalStateException - When the RichPageParameter.Builder.build() method was already called.

allowedPrototypes

@NotNull
DataSetParameter.Builder allowedPrototypes(@NotNull
 PrototypeEnum firstAllowed,
 @Nullable
 PrototypeEnum... otherAllowed)

Description copied from interface: DataSetParameter.Setter

Sets which prototypes will be selectable by a user and overrides the values set by DataSetParameter.Setter.allowedPrototypes(Iterable). If the allowed prototypes do not contain the target prototype then the first allowed prototype is automatically selected as the target prototype.

Specified by:

allowedPrototypes in interface DataSetParameter.Setter

allowedPrototypes

@NotNull
DataSetParameter.Builder allowedPrototypes(@NotNull
 Iterable<String> allowedPrototypes)

Description copied from interface: DataSetParameter.Setter

Sets which prototypes will be selectable by a user and overrides the values set by DataSetParameter.Setter.allowedPrototypes(PrototypeEnum, PrototypeEnum...) If the allowed prototypes do not contain the target prototype then the first allowed prototype is automatically selected as the target prototype.

Specified by:

allowedPrototypes in interface DataSetParameter.Setter

allowCollectionScope

@NotNull
DataSetParameter.Builder allowCollectionScope(boolean allowCollectionScope)

Specified by:

allowCollectionScope in interface DataSetParameter.Setter

Since:

3.25.12