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