Package com.evolveum.midpoint.schema

Enum Class PointInTimeType

java.lang.Object

java.lang.Enum<PointInTimeType>

com.evolveum.midpoint.schema.PointInTimeType

All Implemented Interfaces:

Serializable, Comparable<PointInTimeType>, Constable

public enum PointInTimeType
extends Enum<PointInTimeType>

Specifies the point in time for the returned data. This option controls whether fresh or cached data will be returned or whether future data projection will be returned. MidPoint usually deals with fresh data that describe situation at the current point in time. But the client code may want to get data from the cache that may be possibly stale. Or the client code may want a projection about the future state of the data (e.g. taking running asynchronous operation into consideration).

Author:

semancik

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
CACHED	Return cached data (if available).
CURRENT	Return current data.
FUTURE	Returns current data and applies all the available projections about future state of the data.

Method Summary

Modifier and Type	Method	Description
static PointInTimeType	toPointInTimeType(PointInTimeTypeType value)
static PointInTimeTypeType	toPointInTimeTypeType(PointInTimeType value)
static PointInTimeType	valueOf(String name)	Returns the enum constant of this class with the specified name.
static PointInTimeType[]	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

CACHED

public static final PointInTimeType CACHED

Return cached data (if available). Avoid fetching the data from external system.

CURRENT

public static final PointInTimeType CURRENT

Return current data. Fetch from external system if needed. The "current" has to be understood in Einsteinean sense. The returned data are as fresh as possible - but that still may be hours or days old for some resources. This is usually the default.

FUTURE

public static final PointInTimeType FUTURE

Returns current data and applies all the available projections about future state of the data. E.g. applies projected state of pending asynchronous operations.

Method Details

values

public static PointInTimeType[] 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 PointInTimeType 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

toPointInTimeTypeType

public static PointInTimeTypeType toPointInTimeTypeType(PointInTimeType value)

toPointInTimeType

public static PointInTimeType toPointInTimeType(PointInTimeTypeType value)