DataSetParameter

All Superinterfaces:: CompositeParameter, RichPageParameter

public interface DataSetParameter extends CompositeParameter

Since:: 3.9.0

Nested Class Summary

Nested Classes

Modifier and Type

Interface

Description

static interface

DataSetParameter.Builder

static interface

DataSetParameter.Setter

Nested classes/interfaces inherited from interface com.polarion.alm.shared.api.model.rp.parameter.CompositeParameter
CompositeParameter.BuilderBase<P extends CompositeParameter,B extends CompositeParameter.BuilderBase>

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

DataCountAccessor

countFor()

Returns the accessor for DataCount, that contains the found object count.

BaselineCollectionReference

getCollectionReference()

DataSetAccessor

getFor()

Returns the accessor for DataSet, that contains the found objects.

com.polarion.alm.shared.api.model.rp.parameter.impl.dataset.WidgetContextScope

getWidgetContextScope()

PrototypeEnum

prototype()

Scope

scope()

DataSetParameter.Setter

set()

String

subtype()

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

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

Method Details
- scope
  
  @NotNull Scope scope()
- prototype
  
  @NotNull PrototypeEnum prototype()
- subtype
  
  @Nullable String subtype()
- getFor
  
  @NotNull DataSetAccessor getFor()
  
  Returns the accessor for DataSet, that contains the found objects. If you are only interested in counting the objects, call the faster countFor() method instead.
- set
  
  @NotNull DataSetParameter.Setter set()
  
  Returns:
  
  interface for setting the parameter configuration that can be used inside RichPageWidget.processParameterDependencies(RichPageWidgetDependenciesContext) to change the parameter configuration depending on the values set by a user in the other parameters.
  
  Throws:
  
  UnsupportedOperationException - if this parameter is a page parameter.
  
  Since:
  
  3.9.2
- countFor
  
  DataCountAccessor countFor()
  
  Returns the accessor for DataCount, that contains the found object count. It is optimized to be faster than returning all the objects via the getFor() method.
  
  Since:
  
  3.17.2
- getWidgetContextScope
  
  @NotNull com.polarion.alm.shared.api.model.rp.parameter.impl.dataset.WidgetContextScope getWidgetContextScope()
  
  Since:
  
  3.25.12
- getCollectionReference
  
  @Nullable BaselineCollectionReference getCollectionReference()
  
  Since:
  
  3.25.12