Package io.ebeaninternal.api
Enum SpiQuery.TemporalMode
- java.lang.Object
-
- java.lang.Enum<SpiQuery.TemporalMode>
-
- io.ebeaninternal.api.SpiQuery.TemporalMode
-
- All Implemented Interfaces:
Serializable
,Comparable<SpiQuery.TemporalMode>
public static enum SpiQuery.TemporalMode extends Enum<SpiQuery.TemporalMode>
-
-
Enum Constant Summary
Enum Constants Enum Constant Description AS_OF
Query runs 'As Of' a given date time.CURRENT
Query runs against current data (normal).DRAFT
Query runs against draft tables.SOFT_DELETED
Includes soft deletes rows in the result.VERSIONS
Query runs potentially returning many versions of the same bean.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
isHistory()
Return true if this is a history query.static SpiQuery.TemporalMode
of(SpiQuery<?> query)
Return the mode of the query of if null return CURRENT mode.static SpiQuery.TemporalMode
valueOf(String name)
Returns the enum constant of this type with the specified name.static SpiQuery.TemporalMode[]
values()
Returns an array containing the constants of this enum type, in the order they are declared.
-
-
-
Enum Constant Detail
-
SOFT_DELETED
public static final SpiQuery.TemporalMode SOFT_DELETED
Includes soft deletes rows in the result.
-
DRAFT
public static final SpiQuery.TemporalMode DRAFT
Query runs against draft tables.
-
CURRENT
public static final SpiQuery.TemporalMode CURRENT
Query runs against current data (normal).
-
VERSIONS
public static final SpiQuery.TemporalMode VERSIONS
Query runs potentially returning many versions of the same bean.
-
AS_OF
public static final SpiQuery.TemporalMode AS_OF
Query runs 'As Of' a given date time.
-
-
Method Detail
-
values
public static SpiQuery.TemporalMode[] values()
Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:for (SpiQuery.TemporalMode c : SpiQuery.TemporalMode.values()) System.out.println(c);
- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
public static SpiQuery.TemporalMode valueOf(String name)
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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 type has no constant with the specified nameNullPointerException
- if the argument is null
-
isHistory
public boolean isHistory()
Return true if this is a history query.
-
of
public static SpiQuery.TemporalMode of(SpiQuery<?> query)
Return the mode of the query of if null return CURRENT mode.
-
-