SeparateByParameter

All Superinterfaces:: RichPageParameter

public interface SeparateByParameter extends RichPageParameter

Parameter for configuring a field of enum type which can be used together with DataSetParameter.

The parameter returns list of categories() which represent the configured allowed values for the selected field and can be used in DataSetAccessor.category(SeparateByCategory).

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

SeparateByParameter.Builder

static interface

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

ImmutableStrictList<SeparateByCategory>

categories()

Returned objects can be used in DataSetAccessor.category(SeparateByCategory).

Enumeration

enumeration()

Returns enumeration for the selected field (returned by field() method)

String

field()

Returns selected field id specified for parameter

boolean

isSelected()

Says that user defined some value of the parameter

SeparateByParameter.Setter

set()

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

Method Details
- categories
  
  @NotNull ImmutableStrictList<SeparateByCategory> categories()
  
  Returned objects can be used in DataSetAccessor.category(SeparateByCategory).
- isSelected
  
  boolean isSelected()
  
  Says that user defined some value of the parameter
- field
  
  @Nullable String field()
  
  Returns selected field id specified for parameter
  
  Since:
  
  3.10.2
- enumeration
  
  @Nullable Enumeration enumeration()
  
  Returns enumeration for the selected field (returned by field() method)
  
  Since:
  
  3.10.2
- set
  
  @NotNull SeparateByParameter.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