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

Interface FieldsParameter.Builder

All Superinterfaces:

FieldsParameter.Setter, RichPageParameter.Builder<FieldsParameter,FieldsParameter.Builder>

Enclosing interface:

FieldsParameter

public static interface FieldsParameter.Builder
extends FieldsParameter.Setter, RichPageParameter.Builder<FieldsParameter,FieldsParameter.Builder>

Method Summary

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

Not using this method means to use the current scope.

Specified by:

scope in interface FieldsParameter.Setter

Since:

3.9.3

prototype

@NotNull
PrototypeSelector<FieldsParameter.Builder> 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.

Specified by:

prototype in interface FieldsParameter.Setter

Since:

3.9.3

structure

@NotNull
StructureSelector<FieldsParameter.Builder> structure()

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

Specified by:

structure in interface FieldsParameter.Setter

Since:

3.10.0

See Also:

• StructureEnum

subtype

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

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

Specified by:

subtype in interface FieldsParameter.Setter

Since:

3.9.3

allowedFields

@NotNull
FieldsParameter.Builder 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.

Specified by:

allowedFields in interface FieldsParameter.Setter

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.Builder 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.

Specified by:

disallowedFields in interface FieldsParameter.Setter

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.Builder fields(@NotNull
 Iterable<String> fields)

Specified by:

fields in interface FieldsParameter.Setter