001package ca.uhn.fhir.rest.api;
002
003/*
004 * #%L
005 * HAPI FHIR - Core Library
006 * %%
007 * Copyright (C) 2014 - 2022 Smile CDR, Inc.
008 * %%
009 * Licensed under the Apache License, Version 2.0 (the "License");
010 * you may not use this file except in compliance with the License.
011 * You may obtain a copy of the License at
012 *
013 *      http://www.apache.org/licenses/LICENSE-2.0
014 *
015 * Unless required by applicable law or agreed to in writing, software
016 * distributed under the License is distributed on an "AS IS" BASIS,
017 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
018 * See the License for the specific language governing permissions and
019 * limitations under the License.
020 * #L%
021 */
022
023/**
024 * Enumerated type to represent the various allowable syntax for a search/query
025 * as described in the  
026 * <a href="http://www.hl7.org/implement/standards/fhir/http.html#search">FHIR Specification Section 2.1.11</a>
027 */
028public enum SearchStyleEnum {
029
030        /**
031         * This is the most common (and generally the default) behaviour. Performs the search using the style:
032         * <br>
033         * <code>GET [base]/[resource type]?[params]</code>
034         */
035        GET,
036        
037        /**
038         * Performs the search using the style below. Note that this style is less commonly supported
039         * in servers so it should not be used unless there is a specific reason for needing to.
040         * <br>
041         * <code>GET [base]/[resource type]/_search?[params]</code>
042         */
043        GET_WITH_SEARCH,
044
045        /**
046         * Performs the search using the style below. This style is useful when you have long search strings.
047         * <br>
048         * <code>POST [base]/[resource type]/_search</code>
049         * <br>
050         * and the params in a form encoded POST body.
051         */
052        POST
053        
054}