001/*-
002 * #%L
003 * HAPI FHIR JPA Server
004 * %%
005 * Copyright (C) 2014 - 2025 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.jpa.provider;
021
022import ca.uhn.fhir.replacereferences.ReplaceReferencesRequest;
023import ca.uhn.fhir.rest.api.server.RequestDetails;
024import org.hl7.fhir.instance.model.api.IBaseParameters;
025import org.hl7.fhir.instance.model.api.IIdType;
026
027/**
028 * Find all references to a source resource and replace them with references to the provided target
029 */
030public interface IReplaceReferencesSvc {
031
032        /**
033         * Find all references to a source resource and replace them with references to the provided target
034         */
035        IBaseParameters replaceReferences(
036                        ReplaceReferencesRequest theReplaceReferencesRequest, RequestDetails theRequestDetails);
037
038        /**
039         * To support $merge preview mode, provide a count of how many references would be updated if replaceReferences
040         * was called
041         */
042        Integer countResourcesReferencingResource(IIdType theResourceId, RequestDetails theRequestDetails);
043}