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

Interface FieldsParameter.Setter

All Known Subinterfaces:

FieldsParameter.Builder

Enclosing interface:

FieldsParameter

public static interface FieldsParameter.Setter

Since:

3.9.2

Method Summary

Modifier and Type	Method	Description
FieldsParameter.Setter	allowedFields(Iterable<String> fields)	Used to select allowed field ids.
FieldsParameter.Setter	disallowedFields(Iterable<String> fields)	Used to select allowed field ids.
FieldsParameter.Setter	fields(Iterable<String> fields)
PrototypeSelector<? extends FieldsParameter.Setter>	prototype()	Clears the subtype set by subtype(String), so this method must be used before using subtype(String).
ScopeSelector<? extends FieldsParameter.Setter>	scope()	Not using this method means to use the current scope.
StructureSelector<? extends FieldsParameter.Setter>	structure()	Used to select one of available structure types.
FieldsParameter.Setter	subtype(String value)	Must be used after prototype() otherwise the value is lost.

Method Details

scope

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

Not using this method means to use the current scope.

Since:

3.9.3

prototype

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

Clears the subtype set by subtype(String), so this method must be used before using subtype(String). Also clears the structure type selected using selector returned by structure() method.

Since:

3.9.3

structure

@NotNull
StructureSelector<? extends FieldsParameter.Setter> structure()

Used to select one of available structure types. After invoking this method values set by methods prototype() and subtype(String) will be ignored.

Since:

3.10.0

See Also:

• StructureEnum

subtype

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

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

Since:

3.9.3

allowedFields

@NotNull
FieldsParameter.Setter allowedFields(@Nullable
 Iterable<String> fields)

Used to select allowed field ids. Can be used in combination with other methods. Using this method in combination with disallowedFields(Iterable) will reset disallowed field ids collection.

Parameters:

fields - collection of not null field ids. Fields that are not in this collection will be excluded from available fields gotten by applying scope(), prototype(), subtype(String) and structure() methods. If set to null all available fields are allowed.

Since:

3.10.0

disallowedFields

@NotNull
FieldsParameter.Setter disallowedFields(@Nullable
 Iterable<String> fields)

Used to select allowed field ids. Can be used in combination with other methods. Using this method in combination with allowedFields(Iterable) will reset allowed field ids collection.

Parameters:

fields - collection of not null field ids. Fields in this collection will be excluded from available fields gotten by applying scope(), prototype(), subtype(String) and structure() methods. If set to null or empty all available fields are allowed.

Since:

3.10.0

fields

@NotNull
FieldsParameter.Setter fields(@NotNull
 Iterable<String> fields)