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.gclient;
021
022import ca.uhn.fhir.rest.api.MethodOutcome;
023import ca.uhn.fhir.rest.api.PreferReturnEnum;
024
025public interface ICreateTyped extends IClientExecutable<ICreateTyped, MethodOutcome> {
026
027        /**
028         * @since HAPI 0.9 / FHIR DSTU 2
029         */
030        ICreateWithQuery conditional();
031
032        /**
033         * Specifies that the create should be performed as a conditional create
034         * against a given search URL.
035         *
036         * @param theSearchUrl The search URL to use. The format of this URL should be of the form <code>[ResourceType]?[Parameters]</code>,
037         *                     for example: <code>Patient?name=Smith&amp;identifier=13.2.4.11.4%7C847366</code>
038         * @since HAPI 0.9 / FHIR DSTU 2
039         */
040        ICreateTyped conditionalByUrl(String theSearchUrl);
041
042        /**
043         * Add a <code>Prefer</code> header to the request, which requests that the server include
044         * or suppress the resource body as a part of the result. If a resource is returned by the server
045         * it will be parsed an accessible to the client via {@link MethodOutcome#getResource()}
046         *
047         * @since HAPI 1.1
048         */
049        ICreateTyped prefer(PreferReturnEnum theReturn);
050}