Package com.polarion.alm.shared.api.model.eo

Interface EnumOptionField

All Superinterfaces:

CanBeCustomField, CanRender<Renderer<? extends Renderer<?>>>, Field, ScalarField<EnumOption>

All Known Subinterfaces:

UpdatableEnumOptionField

public interface EnumOptionField
extends ScalarField<EnumOption>, CanBeCustomField

Since:

3.9.0

Method Summary

Modifier and Type	Method	Description
Enumeration	enumeration()
HtmlLink	iconLink()
String	optionId()	Shortcut for ScalarField.get().EnumOption.id() Will return null if option is null
String	optionIdIfCan()	Shortcut for ScalarField.getIfCan().EnumOption.id() Will return null if option is null
EnumOptionRenderer	render()	This method can be used also when the parent object is unresolvable or user has no permission to access.

Methods inherited from interface com.polarion.alm.shared.api.model.fields.CanBeCustomField

containsIncompatibleValue

Methods inherited from interface com.polarion.alm.shared.api.model.fields.Field

can, compareWith, description, id, is, label

Methods inherited from interface com.polarion.alm.shared.api.model.fields.ScalarField

get, getIfCan

Method Details

iconLink

@Nullable
HtmlLink iconLink()

render

@NotNull
EnumOptionRenderer render()

Description copied from interface: Field

This method can be used also when the parent object is unresolvable or user has no permission to access. In both cases the method will just render nothing and not throw any exceptions.

Specified by:

render in interface CanRender<Renderer<? extends Renderer<?>>>

Specified by:

render in interface Field

optionId

@Nullable
String optionId()

Shortcut for ScalarField.get().EnumOption.id()
Will return null if option is null

Since:

3.9.1

optionIdIfCan

@Nullable
String optionIdIfCan()

Shortcut for ScalarField.getIfCan().EnumOption.id()
Will return null if option is null

Since:

3.10.0

enumeration

@NotNull
Enumeration enumeration()

Returns:

the Enumeration for this field.

Since:

3.21.1