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 org.hl7.fhir.instance.model.api.IBaseResource;
023import org.hl7.fhir.instance.model.api.IIdType;
024
025public interface IReadTyped<T extends IBaseResource> {
026
027        /**
028         * Perform a search by resource ID
029         *
030         * @param theId The resource ID, e.g. "123"
031         */
032        IReadExecutable<T> withId(String theId);
033
034        /**
035         * Perform a search by resource ID and version
036         *
037         * @param theId The resource ID, e.g. "123"
038         * @param theVersion The resource version, eg. "5"
039         */
040        IReadExecutable<T> withIdAndVersion(String theId, String theVersion);
041
042        /**
043         * Perform a search by resource ID
044         *
045         * @param theId The resource ID, e.g. "123"
046         */
047        IReadExecutable<T> withId(Long theId);
048
049        /**
050         * Search using an ID. Note that even if theId contains a base URL it will be
051         * ignored in favour of the base url for the given client. If you want to specify
052         * an absolute URL including a base and have that base used instead, use
053         * {@link #withUrl(IIdType)}
054         */
055        IReadExecutable<T> withId(IIdType theId);
056
057        IReadExecutable<T> withUrl(String theUrl);
058
059        IReadExecutable<T> withUrl(IIdType theUrl);
060}