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