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

Interface SortingParameter

All Superinterfaces:

RichPageParameter

public interface SortingParameter
extends RichPageParameter

Parameter for configuring sorting of items by the fields()

Must be put inside the DataSetParameter using the DataSetParameter.Builder.add(String, RichPageParameter) to work correctly.

Since:

3.9.0

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	SortingParameter.Builder
static interface	SortingParameter.Setter

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

RichPageParameter.Visuals

Method Summary

Modifier and Type	Method	Description
String	asLuceneSortString()	Can be used in DataSetAccessor.sort(String).
ImmutableStrictList<SortingField>	fields()
SortingParameter.Setter	set()

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

label, visuals

Method Details

fields

@NotNull
ImmutableStrictList<SortingField> fields()

asLuceneSortString

@Nullable
String asLuceneSortString()

Can be used in DataSetAccessor.sort(String).

Returns:

null when no sorting fields were selected by user.

set

@NotNull
SortingParameter.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