Package ca.uhn.fhir.jpa.model.search

Enum Class SearchStatusEnum

java.lang.Object

java.lang.Enum<SearchStatusEnum>

ca.uhn.fhir.jpa.model.search.SearchStatusEnum

All Implemented Interfaces:

Serializable, Comparable<SearchStatusEnum>, Constable

public enum SearchStatusEnum
extends Enum<SearchStatusEnum>

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
FAILED	The search failed and will not continue
FINISHED	The search completed normally and loaded all of the results it as permitted to load
GONE	The search has been expired and will be expunged shortly
LOADING	The search is currently actively working
PASSCMPLET	The search has loaded a set of results and has stopped searching because it reached an appropriate threshold

Method Summary

Modifier and Type	Method	Description
boolean	isDone()	Returns true if no more work will happen for this search (finished, failed, gone)
static SearchStatusEnum	valueOf(String name)	Returns the enum constant of this class with the specified name.
static SearchStatusEnum[]	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

LOADING

public static final SearchStatusEnum LOADING

The search is currently actively working

PASSCMPLET

public static final SearchStatusEnum PASSCMPLET

The search has loaded a set of results and has stopped searching because it reached an appropriate threshold

FINISHED

public static final SearchStatusEnum FINISHED

The search completed normally and loaded all of the results it as permitted to load

FAILED

public static final SearchStatusEnum FAILED

The search failed and will not continue

GONE

public static final SearchStatusEnum GONE

The search has been expired and will be expunged shortly

Method Details

values

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

isDone

public boolean isDone()

Returns true if no more work will happen for this search (finished, failed, gone)