001package ca.uhn.fhir.rest.gclient;
002
003import ca.uhn.fhir.rest.api.SummaryEnum;
004
005/*
006 * #%L
007 * HAPI FHIR - Core Library
008 * %%
009 * Copyright (C) 2014 - 2016 University Health Network
010 * %%
011 * Licensed under the Apache License, Version 2.0 (the "License");
012 * you may not use this file except in compliance with the License.
013 * You may obtain a copy of the License at
014 * 
015 *      http://www.apache.org/licenses/LICENSE-2.0
016 * 
017 * Unless required by applicable law or agreed to in writing, software
018 * distributed under the License is distributed on an "AS IS" BASIS,
019 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
020 * See the License for the specific language governing permissions and
021 * limitations under the License.
022 * #L%
023 */
024
025
026public interface IClientExecutable<T extends IClientExecutable<?,?>, Y> {
027
028        /**
029         * If set to true, the client will log the request and response to the SLF4J logger. This can be useful for
030         * debugging, but is generally not desirable in a production situation.
031         * 
032         * @deprecated Use the client logging interceptor to log requests and responses instead. See <a href="http://jamesagnew.github.io/hapi-fhir/doc_rest_client.html#req_resp_logging">here</a> for more information.
033         */
034        @Deprecated
035        T andLogRequestAndResponse(boolean theLogRequestAndResponse);
036
037        /**
038         * Request that the server return subsetted resources, containing only the elements specified in the given parameters. 
039         * For example: <code>subsetElements("name", "identifier")</code> requests that the server only return
040         * the "name" and "identifier" fields in the returned resource, and omit any others.  
041         */
042        T elementsSubset(String... theElements);
043
044        T encodedJson();
045
046        T encodedXml();
047
048        Y execute();
049
050        T prettyPrint();
051
052        /**
053         * Request that the server modify the response using the <code>_summary</code> param 
054         */
055        T summaryMode(SummaryEnum theSummary);
056
057}