Package io.jmix.appsettings

Enum Class AppSettingsEntityLoadMode

java.lang.Object

java.lang.Enum<AppSettingsEntityLoadMode>

io.jmix.appsettings.AppSettingsEntityLoadMode

All Implemented Interfaces:

Serializable, Comparable<AppSettingsEntityLoadMode>, Constable

public enum AppSettingsEntityLoadMode
extends Enum<AppSettingsEntityLoadMode>

Defines how application settings entity should be resolved for the current context.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
FOR_READ	Loads settings for reading.
FOR_SAVE	Loads settings for saving.

Method Summary

Modifier and Type	Method	Description
static AppSettingsEntityLoadMode	valueOf(String name)	Returns the enum constant of this class with the specified name.
static AppSettingsEntityLoadMode[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

FOR_READ

public static final AppSettingsEntityLoadMode FOR_READ

Loads settings for reading.

Use this mode when effective settings values are needed. For tenant-aware settings it returns the tenant-specific record if it exists, otherwise falls back to the global record.

FOR_SAVE

public static final AppSettingsEntityLoadMode FOR_SAVE

Loads settings for saving.

Use this mode when the returned entity will be updated and saved. For tenant-aware settings it returns the tenant-specific record if it exists, otherwise creates a new tenant-specific record instead of updating the global fallback record.

Method Details

values

public static AppSettingsEntityLoadMode[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static AppSettingsEntityLoadMode valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null