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

Interface CanBeCustomField

All Superinterfaces:

CanRender<Renderer<? extends Renderer<?>>>, Field

All Known Subinterfaces:

AttachmentBaseUrlField, AvatarField, BooleanField, CodeField, CurrencyField, DateField, DateOnlyField, DurationField, EnumOptionField, EnumOptionsField, FieldReferenceField, FloatField, HyperlinkUriField, IntegerField, LinkedResourcePositionField, PlainTextField, RichTextField, SpaceField, StringField, TimeOnlyField, UpdatableBooleanField, UpdatableCanBeCustomField, UpdatableCurrencyField, UpdatableDateField, UpdatableDateOnlyField, UpdatableDurationField, UpdatableEnumOptionField, UpdatableEnumOptionsField, UpdatableFieldReferenceField, UpdatableFloatField, UpdatableIntegerField, UpdatableLongField, UpdatablePlainTextField, UpdatableRichTextField, UpdatableStringField, UpdatableTimeOnlyField

public interface CanBeCustomField
extends Field

Common interface for all fields, that can be used as custom fields. Some of the fields extending this interface can be both custom and normal (hard-coded) fields. To check if the given field is actually a custom field, use Field.is().custom().

Not all of the fields indirectly extending this interface can actually be used as custom fields, mainly the ones extending the StringField.

Since:

3.21.2

Method Summary

Modifier and Type	Method	Description
boolean	containsIncompatibleValue()

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

can, compareWith, description, id, is, label, render

Method Details

containsIncompatibleValue

boolean containsIncompatibleValue()

Returns:

true when the cached value, or the value stored in persistence, for this field is not compatible with the current type of this field. In such cases:

• The normal methods for reading the value, like ScalarField.get() fail with ClassCastException.
• The methods like ScalarField.getIfCan() return nothing.
• The Field.render() method still renders the value, but for some values in a less nice way.