001/*-
002 * #%L
003 * HAPI FHIR - Master Data Management
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.mdm.svc;
021
022import ca.uhn.fhir.interceptor.model.RequestPartitionId;
023import ca.uhn.fhir.jpa.model.dao.JpaPid;
024import org.hl7.fhir.instance.model.api.IBaseResource;
025
026import java.util.Set;
027
028/**
029 * Interface for mdm expanding Group resources on group bulk export
030 */
031public interface IBulkExportMdmResourceExpander {
032
033        /**
034         * For the Group resource with the given id, returns all the persistent id ofs
035         * the members of the group + the mdm matched resources to a member in the group
036         */
037        Set<JpaPid> expandGroup(String groupResourceId, RequestPartitionId requestPartitionId);
038
039        /**
040         * annotates the given resource to be exported with the implementation specific extra information if applicable
041         */
042        void annotateResource(IBaseResource resource);
043}