001package ca.uhn.fhir.mdm.api;
002
003/*-
004 * #%L
005 * HAPI FHIR - Master Data Management
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.mdm.model.MdmTransactionContext;
024import ca.uhn.fhir.rest.api.server.storage.ResourcePersistentId;
025import org.hl7.fhir.instance.model.api.IAnyResource;
026
027import java.util.List;
028
029public interface IMdmLinkSvc {
030
031        /**
032         * Update a link between a Golden Resource record and its source resource record. If a link does not exist between
033         * these two records, create it.
034         *
035         * @param theGoldenResource        the Golden Resource to link the source resource to.
036         * @param theSourceResource        the source resource, which can be of any of the MDM supported types
037         * @param theMatchResult           the current status of the match to set the link to.
038         * @param theLinkSource            MANUAL or AUTO: what caused the link.
039         * @param theMdmTransactionContext
040         */
041        void updateLink(IAnyResource theGoldenResource, IAnyResource theSourceResource, MdmMatchOutcome theMatchResult, MdmLinkSourceEnum theLinkSource, MdmTransactionContext theMdmTransactionContext);
042
043        /**
044         * Delete a link between given Golden Resource and the corresponding source resource
045         *
046         * @param theExistingGoldenResource
047         * @param theSourceResource
048         * @param theMdmTransactionContext
049         */
050        void deleteLink(IAnyResource theExistingGoldenResource, IAnyResource theSourceResource, MdmTransactionContext theMdmTransactionContext);
051
052        /**
053         * Delete all link records whose source or target points to the provided pids.
054         * @param thePersistentIds
055         */
056        void deleteLinksWithAnyReferenceTo(List<ResourcePersistentId> thePersistentIds);
057}