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

Interface FieldsParameter

All Superinterfaces:

RichPageParameter

public interface FieldsParameter
extends RichPageParameter

Parameter for configuring list of fields which can be used for example to configure table columns.

In future it will also allow configuring how the fields should be rendered, so the Field.render(Fields) should be used for the rendering to allow that

If there is no scope and prototype or no structure provided through the DataSetParameter or FieldsParameter.Builder, this parameter will use default values: current scope for scope and PrototypeEnum.WorkItem for prototype. If there are scope, prototype and/or subtype values provided through the DataSetParameter they will override appropriate default values of this parameter or values provided by FieldsParameter.Builder. If there is structure value provided through the FieldsParameter.Setter.structure() defined values for prototype and/or subtype will be ignored.

Since:

3.9.0

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	FieldsParameter.Builder
static interface	FieldsParameter.DefaultFields	Used for setting default fields, when the original set does not suit the use case.
static interface	FieldsParameter.Setter

Nested classes/interfaces inherited from interface com.polarion.alm.shared.api.model.rp.parameter.RichPageParameter

RichPageParameter.Tooltip, RichPageParameter.Visuals

Method Summary

Modifier and Type	Method	Description
FieldsParameter.DefaultFields	defaultFields()	The method is used for accessing the FieldsParameter.DefaultFields interface.
IterableWithSize<Field>	fields()
FieldsParameter.Setter	set()

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

label, tooltip, visuals

Method Details

fields

@NotNull
IterableWithSize<Field> fields()

Returns:

the fields selected by user.

set

@NotNull
FieldsParameter.Setter set()

Returns:

interface for setting parameter configuration which can be used inside RichPageWidget.processParameterDependencies(RichPageWidgetDependenciesContext) to change parameter configuration depending on values set by user in other parameters.

Throws:

UnsupportedOperationException - if this parameter is a page parameter.

Since:

3.9.2

defaultFields

@NotNull
FieldsParameter.DefaultFields defaultFields()

The method is used for accessing the FieldsParameter.DefaultFields interface.

Since:

3.17.2