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

Interface ScriptParameter

All Superinterfaces:

RichPageParameter

public interface ScriptParameter
extends RichPageParameter

Since:

3.9.0

Nested Class Summary

Nested Classes

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

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
ScriptRenderResult	render()	Renders velocity script to ScriptRenderResult object.
String	renderHtml()	Renders velocity script to HTML markup.
ScriptParameter.Setter	set()
String	value()

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

label, tooltip, visuals

Method Details

value

@Nullable
String value()

renderHtml

@GwtIncompatible
@NotNull
String renderHtml()

Renders velocity script to HTML markup. Exceptions that occur during rendering are handled. Resulting humanized message is rendered in warning container.

Returns:

rendered HTML markup.

render

@GwtIncompatible
@NotNull
ScriptRenderResult render()

Renders velocity script to ScriptRenderResult object. Exceptions that occur during rendering are handled. Resulting humanized message and error cause are placed in result object.

Returns:

render result object.

Since:

3.10.1

See Also:

• ScriptRenderResult

set

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