View Javadoc
1   package ca.uhn.fhir.rest.api;
2   
3   /*
4    * #%L
5    * HAPI FHIR - Core Library
6    * %%
7    * Copyright (C) 2014 - 2018 University Health Network
8    * %%
9    * Licensed under the Apache License, Version 2.0 (the "License");
10   * you may not use this file except in compliance with the License.
11   * You may obtain a copy of the License at
12   * 
13   *      http://www.apache.org/licenses/LICENSE-2.0
14   * 
15   * Unless required by applicable law or agreed to in writing, software
16   * distributed under the License is distributed on an "AS IS" BASIS,
17   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
18   * See the License for the specific language governing permissions and
19   * limitations under the License.
20   * #L%
21   */
22  
23  /**
24   * Enumerated type to represent the various allowable syntax for a search/query
25   * as described in the  
26   * <a href="http://www.hl7.org/implement/standards/fhir/http.html#search">FHIR Specification Section 2.1.11</a>
27   */
28  public enum SearchStyleEnum {
29  
30  	/**
31  	 * This is the most common (and generally the default) behaviour. Performs the search using the style:
32  	 * <br>
33  	 * <code>GET [base]/[resource type]?[params]</code>
34  	 */
35  	GET,
36  	
37  	/**
38  	 * Performs the search using the style below. Note that this style is less commonly supported
39  	 * in servers so it should not be used unless there is a specific reason for needing to.
40  	 * <br>
41  	 * <code>GET [base]/[resource type]/_search?[params]</code>
42  	 */
43  	GET_WITH_SEARCH,
44  
45  	/**
46  	 * Performs the search using the style below. This style is useful when you have long search strings.
47  	 * <br>
48  	 * <code>POST [base]/[resource type]/_search</code>
49  	 * <br>
50  	 * and the params in a form encoded POST body.
51  	 */
52  	POST
53  	
54  }