View Javadoc
1   package ca.uhn.fhir.rest.gclient;
2   
3   /*
4    * #%L
5    * HAPI FHIR - Core Library
6    * %%
7    * Copyright (C) 2014 - 2019 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 org.hl7.fhir.instance.model.api.IBaseResource;
25  
26  public interface IOperationUntypedWithInput<T> extends IClientExecutable<IOperationUntypedWithInput<T>, T> {
27  
28  	/**
29  	 * The client should invoke this method using an HTTP GET instead of an HTTP POST. Note that
30  	 * according the the FHIR specification, all methods must support using the POST method, but
31  	 * only certain methods may support the HTTP GET method, so it is generally not necessary
32  	 * to use this feature. 
33  	 * <p>
34  	 * If you have a specific reason for needing to use a GET however, this method will enable it.
35  	 * </p>
36  	 */
37  	IOperationUntypedWithInput<T> useHttpGet();
38  
39  	/**
40  	 * If this operation returns a single resource body as its return type instead of a <code>Parameters</code>
41  	 * resource, use this method to specify that resource type. This is useful for certain
42  	 * operations (e.g. <code>Patient/NNN/$everything</code>) which return a bundle instead of
43  	 * a Parameters resource.
44  	 */
45  	<R extends IBaseResource> IOperationUntypedWithInput<R> returnResourceType(Class<R> theReturnType);
46  
47  	/**
48  	 * Request that the method chain returns a {@link MethodOutcome} object. This object
49  	 * will contain details
50  	 */
51  	IOperationUntypedWithInput<MethodOutcome> returnMethodOutcome();
52  }