Enum Class FindMultipleOption.SessionCheckMode

java.lang.Object

java.lang.Enum<FindMultipleOption.SessionCheckMode>

org.hibernate.FindMultipleOption.SessionCheckMode

All Implemented Interfaces:

FindOption, Serializable, Comparable<FindMultipleOption.SessionCheckMode>, Constable, FindMultipleOption

Enclosing interface:

FindMultipleOption

public static enum FindMultipleOption.SessionCheckMode
extends Enum<FindMultipleOption.SessionCheckMode>
implements FindMultipleOption

Indicates whether the persistence context should be checked for entities matching the identifiers to be loaded -

• Entities which are in a managed state are not reloaded from the database. Those identifiers are removed from the SQL restriction sent to the database.
• Entities which are in a removed state are replaced with null from the result by default, but can be included if desired.

The default is DISABLED.

Since:

7.2

Nested Class Summary

Nested classes/interfaces inherited from class Enum

Enum.EnumDesc<E>

Nested classes/interfaces inherited from interface FindMultipleOption

FindMultipleOption.BatchSize, FindMultipleOption.OrderingMode, FindMultipleOption.RemovalsMode, FindMultipleOption.SessionCheckMode

Enum Constant Summary

Enum Constants

Enum Constant	Description
DISABLED	The default.
ENABLED	The persistence context will be checked.

Method Summary

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

Methods inherited from class Enum

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

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

ENABLED

public static final FindMultipleOption.SessionCheckMode ENABLED

The persistence context will be checked. Identifiers for entities already contained in the persistence context will not be sent to the database for loading. If the entity is marked for removal in the persistence context, whether it is returned is controlled by FindMultipleOption.RemovalsMode.

See Also:

• FindMultipleOption.RemovalsMode

DISABLED

public static final FindMultipleOption.SessionCheckMode DISABLED

The default. All identifiers to be loaded will be read from the database and returned.

Method Details

values

public static FindMultipleOption.SessionCheckMode[] 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 FindMultipleOption.SessionCheckMode 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