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

Interface DataSetParameter.Setter

All Known Subinterfaces:

DataSetParameter.Builder

Enclosing interface:

DataSetParameter

public static interface DataSetParameter.Setter

Since:

3.9.2

Method Summary

Modifier and Type	Method	Description
DataSetParameter.Setter	allowedPrototypes(PrototypeEnum firstAllowed, PrototypeEnum... otherAllowed)	Sets which prototypes will be selectable by a user and overrides the values set by allowedPrototypes(Iterable).
DataSetParameter.Setter	allowedPrototypes(Iterable<String> allowedPrototypes)	Sets which prototypes will be selectable by a user and overrides the values set by 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.Setter	lucenePlusVelocityQuery(String value)
DataSetParameter.Setter	luceneQuery(String value)
PrototypeSelector<? extends DataSetParameter.Setter>	prototype()	Clears the subtype defined by subtype(String), so it must be used before using subtype(String).
ScopeSelector<? extends DataSetParameter.Setter>	scope()	Current scope is used when this method is NOT called.
DataSetParameter.Setter	sqlPlusVelocityQuery(String columnsQuery, String tablesQuery, String restQuery)
DataSetParameter.Setter	sqlQuery(String columnsQuery, String tablesQuery, String restQuery)
DataSetParameter.Setter	subtype(String value)	Must be used after prototype(), otherwise the value is lost.

Method Details

scope

@NotNull
ScopeSelector<? extends DataSetParameter.Setter> scope()

Current scope is used when this method is NOT called.

prototype

@NotNull
PrototypeSelector<? extends DataSetParameter.Setter> prototype()

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

subtype

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

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

luceneQuery

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

lucenePlusVelocityQuery

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

sqlQuery

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

sqlPlusVelocityQuery

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

allowedPrototypes

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

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

allowedPrototypes

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

Sets which prototypes will be selectable by a user and overrides the values set by 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.

Throws:

IllegalArgumentException - if no value is specified or one of the specified values is not the name of a constant from PrototypeEnum.

NullPointerException - if one of the values is null.