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