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

Interface DateParameter

All Superinterfaces:

ParameterUsableInQuery, RichPageParameter

public interface DateParameter
extends RichPageParameter, ParameterUsableInQuery

Since:

3.9.0

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	DateParameter.Builder
static interface	DateParameter.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
boolean	isRelative()
Integer	relativeShift()
DateParameter.Setter	set()
Date	value()	Returns the date computed from the user input.

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

toLucene, toSql

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

label, visuals

Method Details

value

@NotNull
Date value()

Returns the date computed from the user input.

isRelative

boolean isRelative()

Returns:

true when user selected the relative date

relativeShift

@Nullable
Integer relativeShift()

Returns:

relative shift in days if the parameter is relative, null otherwise.

Since:

3.22.2

set

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