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 org.hl7.fhir.instance.model.api.IBaseResource; 024 025public interface IOperationUntypedWithInput<T> extends IClientExecutable<IOperationUntypedWithInput<T>, T> { 026 027 /** 028 * The client should invoke this method using an HTTP GET instead of an HTTP POST. Note that 029 * according the the FHIR specification, all methods must support using the POST method, but 030 * only certain methods may support the HTTP GET method, so it is generally not necessary 031 * to use this feature. 032 * <p> 033 * If you have a specific reason for needing to use a GET however, this method will enable it. 034 * </p> 035 */ 036 IOperationUntypedWithInput<T> useHttpGet(); 037 038 /** 039 * If this operation returns a single resource body as its return type instead of a <code>Parameters</code> 040 * resource, use this method to specify that resource type. This is useful for certain 041 * operations (e.g. <code>Patient/NNN/$everything</code>) which return a bundle instead of 042 * a Parameters resource. 043 * <p> 044 * Passing in {@literal Binary.class} allows any arbitrary response to be returned. Any payload at 045 * all will be read as raw bytes into a Binary resource. 046 */ 047 <R extends IBaseResource> IOperationUntypedWithInput<R> returnResourceType(Class<R> theReturnType); 048 049 /** 050 * Request that the method chain returns a {@link MethodOutcome} object. This object 051 * will contain details 052 */ 053 IOperationUntypedWithInput<MethodOutcome> returnMethodOutcome(); 054}