Package ca.uhn.fhir.rest.server.util

Enum ISearchParamRegistry.SearchParamLookupContextEnum

java.lang.Object

java.lang.Enum<ISearchParamRegistry.SearchParamLookupContextEnum>

ca.uhn.fhir.rest.server.util.ISearchParamRegistry.SearchParamLookupContextEnum

All Implemented Interfaces:

Serializable, Comparable<ISearchParamRegistry.SearchParamLookupContextEnum>

Enclosing interface:

ISearchParamRegistry

public static enum ISearchParamRegistry.SearchParamLookupContextEnum
extends Enum<ISearchParamRegistry.SearchParamLookupContextEnum>

Describes the context for looking up individual search parameters or lists of search parameters. These can be thought of as filter criteria - Most search parameters generally apply to all context, but some may be explicitly defined to only work for some.

Since:

8.0.0

Enum Constant Summary

Enum Constants

Enum Constant	Description
ALL	Return any search parameters that are known to the system for any context
INDEX	Search parameter should be used when indexing a resource that is being persisted
SEARCH	Search parameter should be used for searching.
SORT	Search parameter should be used for sorting via the _sort parameter.

Method Summary

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

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

INDEX

public static final ISearchParamRegistry.SearchParamLookupContextEnum INDEX

Search parameter should be used when indexing a resource that is being persisted

SEARCH

public static final ISearchParamRegistry.SearchParamLookupContextEnum SEARCH

Search parameter should be used for searching. This includes explicit searches such as standard REST FHIR searches, but also includes resolving match URLs, subscription criteria, etc.

SORT

public static final ISearchParamRegistry.SearchParamLookupContextEnum SORT

Search parameter should be used for sorting via the _sort parameter.

ALL

public static final ISearchParamRegistry.SearchParamLookupContextEnum ALL

Return any search parameters that are known to the system for any context

Method Details

values

public static ISearchParamRegistry.SearchParamLookupContextEnum[] values()

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

Returns:

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

valueOf

public static ISearchParamRegistry.SearchParamLookupContextEnum 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 name

NullPointerException - if the argument is null