Package ca.uhn.fhir.rest.api

Enum Class SearchStyleEnum

java.lang.Object

java.lang.Enum<SearchStyleEnum>

ca.uhn.fhir.rest.api.SearchStyleEnum

All Implemented Interfaces:

Serializable, Comparable<SearchStyleEnum>, Constable

public enum SearchStyleEnum
extends Enum<SearchStyleEnum>

Enumerated type to represent the various allowable syntax for a search/query as described in the FHIR Specification Section 2.1.11

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
GET	This is the most common (and generally the default) behaviour.
GET_WITH_SEARCH	Performs the search using the style below.
POST	Performs the search using the style below.

Method Summary

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

GET

public static final SearchStyleEnum GET

This is the most common (and generally the default) behaviour. Performs the search using the style:
GET [base]/[resource type]?[params]

GET_WITH_SEARCH

public static final SearchStyleEnum GET_WITH_SEARCH

Performs the search using the style below. Note that this style is less commonly supported in servers so it should not be used unless there is a specific reason for needing to.
GET [base]/[resource type]/_search?[params]

POST

public static final SearchStyleEnum POST

Performs the search using the style below. This style is useful when you have long search strings.
POST [base]/[resource type]/_search
and the params in a form encoded POST body.

Method Details

values

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