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

Interface DataSetAccessor

public interface DataSetAccessor

Accessor for DataSet that allows for the use of optional parameters like category(SeparateByCategory)

Since:

3.9.0

Method Summary

Modifier and Type	Method	Description
DataSetAccessor	category(SeparateByCategory category)	Specify optional SeparateByCategory
DataSet	interval(IntervalField field, TimeAxisInterval interval)	Completes the DataSet access.
DataSet	revision(String revision)	Completes the DataSet access.
DataSetAccessor	sort(String sort)	Specify an optional Lucene sorting string.

Method Details

revision

@NotNull
DataSet revision(@Nullable
 String revision)

Completes the DataSet access.

Throws:

IllegalStateException - if this accessor has already completed.

interval

@NotNull
DataSet interval(@NotNull
 IntervalField field,
 @NotNull
 TimeAxisInterval interval)

Completes the DataSet access. The data set contains items for the field that has a value in the specified interval.

Throws:

UnsupportedOperationException - when a query other than a Lucene query is used. (This is the current behavior. It might change in the future.)

IllegalStateException - if this accessor has already completed.

category

@NotNull
DataSetAccessor category(@Nullable
 SeparateByCategory category)

Specify optional SeparateByCategory

Returns:

The same instance to allow for method chaining.

Throws:

IllegalStateException - if this accessor has already completed.

sort

@NotNull
DataSetAccessor sort(@Nullable
 String sort)

Specify an optional Lucene sorting string. (It is currently ignored when something else, other than a Lucene query is done by a user.)
The format is same as for ModelObjectsSearch.sort(String).

Returns:

The same instance allows for method chaining.

Throws:

IllegalStateException - if this accessor has already completed.