Interface Enumeration

All Superinterfaces:
CanRender<Renderer<? extends Renderer<?>>>, HasReference<ModelEntityReference>, ModelEntity, ModelEntityBase<Enumeration,EnumerationReference>

public interface Enumeration extends ModelEntityBase<Enumeration,EnumerationReference>
Since:
3.9.0
  • Method Details

    • byId

      @NotNull EnumOption byId(@NotNull String optionId)
    • defaultOption

      @Nullable EnumOption defaultOption()
    • options

      @NotNull IterableWithSize<EnumOption> options()
    • options

      @NotNull IterableWithSize<EnumOption> options(@Nullable EnumOption currentValue)
      Parameters:
      currentValue - - value which will be added to the result when it is not defined by the enumeration. Used for cases when old persisted value is no longer defined.
    • options

      @NotNull IterableWithSize<EnumOption> options(@Nullable String... currentValueIds)
      Parameters:
      currentValueIds - - values which will be added to the result when it is not defined by the enumeration. Used for cases when old persisted value is no longer defined.
      See Also:
    • label

      @NotNull String label()
    • optionalFieldName

      @Nullable String optionalFieldName()
    • isDefined

      boolean isDefined(@Nullable String optionId)
      Returns true if given option id is defined.
      Parameters:
      optionId - option id, null means false is returned
      Since:
      3.10.1