View Javadoc
1   package ca.uhn.fhir.rest.gclient;
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  import ca.uhn.fhir.rest.api.MethodOutcome;
24  import ca.uhn.fhir.rest.api.PreferReturnEnum;
25  
26  public interface ICreateTyped extends IClientExecutable<ICreateTyped, MethodOutcome> {
27  	
28  	/**
29  	 * @since HAPI 0.9 / FHIR DSTU 2
30  	 */
31  	ICreateWithQuery conditional();
32  
33  	/**
34  	 * Specifies that the create should be performed as a conditional create
35  	 * against a given search URL.
36  	 *
37  	 * @param theSearchUrl The search URL to use. The format of this URL should be of the form <code>[ResourceType]?[Parameters]</code>,
38  	 *                     for example: <code>Patient?name=Smith&amp;identifier=13.2.4.11.4%7C847366</code>
39  	 * @since HAPI 0.9 / FHIR DSTU 2
40  	 */
41  	ICreateTyped conditionalByUrl(String theSearchUrl);
42  
43  	/**
44  	 * Add a <code>Prefer</code> header to the request, which requests that the server include 
45  	 * or suppress the resource body as a part of the result. If a resource is returned by the server
46  	 * it will be parsed an accessible to the client via {@link MethodOutcome#getResource()}
47  	 * 
48  	 * @since HAPI 1.1
49  	 */
50  	ICreateTyped prefer(PreferReturnEnum theReturn);
51  
52  }