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