001package ca.uhn.fhir.jpa.searchparam.extractor;
002
003/*-
004 * #%L
005 * HAPI FHIR Search Parameters
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.context.RuntimeSearchParam;
024import ca.uhn.fhir.interceptor.model.RequestPartitionId;
025import ca.uhn.fhir.jpa.model.cross.IResourceLookup;
026import ca.uhn.fhir.rest.api.server.RequestDetails;
027import ca.uhn.fhir.rest.api.server.storage.TransactionDetails;
028import org.hl7.fhir.instance.model.api.IBaseReference;
029import org.hl7.fhir.instance.model.api.IBaseResource;
030import org.hl7.fhir.instance.model.api.IIdType;
031
032public interface IResourceLinkResolver {
033
034        /**
035         * This method resolves the target of a reference found within a resource that is being created/updated. We do this
036         * so that we can create indexed links between resources, and so that we can validate that the target actually
037         * exists in cases where we need to check that.
038         * <p>
039         * This method returns an {@link IResourceLookup} so as to avoid needing to resolve the entire resource.
040         *
041         * @param theRequestPartitionId The partition ID of the target resource
042         * @param theSearchParam        The param that is being indexed
043         * @param theSourcePath         The path within the resource where this reference was found
044         * @param theSourceResourceId   The ID of the resource containing the reference to the target being resolved
045         * @param theTypeString         The type of the resource being resolved
046         * @param theType               The resource type of the target
047         * @param theReference          The reference being resolved
048         * @param theRequest            The incoming request, if any
049         * @param theTransactionDetails
050         */
051        IResourceLookup findTargetResource(RequestPartitionId theRequestPartitionId, RuntimeSearchParam theSearchParam, String theSourcePath, IIdType theSourceResourceId, String theTypeString, Class<? extends IBaseResource> theType, IBaseReference theReference, RequestDetails theRequest, TransactionDetails theTransactionDetails);
052
053        void validateTypeOrThrowException(Class<? extends IBaseResource> theType);
054
055}