
Package ca.uhn.fhir.rest.api
Enum SearchStyleEnum
- java.lang.Object
-
- java.lang.Enum<SearchStyleEnum>
-
- ca.uhn.fhir.rest.api.SearchStyleEnum
-
- All Implemented Interfaces:
Serializable
,Comparable<SearchStyleEnum>
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
-
-
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
All Methods Static Methods Concrete Methods Modifier and Type Method Description static SearchStyleEnum
valueOf(String name)
Returns the enum constant of this type with the specified name.static SearchStyleEnum[]
values()
Returns an array containing the constants of this enum type, in the order they are declared.
-
-
-
Enum Constant Detail
-
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 Detail
-
values
public static SearchStyleEnum[] 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 (SearchStyleEnum c : SearchStyleEnum.values()) System.out.println(c);
- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
public static SearchStyleEnum 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
-
-