001/*-
002 * #%L
003 * HAPI FHIR - Server Framework
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.rest.api.server.bulk;
021
022import ca.uhn.fhir.interceptor.model.RequestPartitionId;
023import ca.uhn.fhir.rest.api.server.IBundleProvider;
024import ca.uhn.fhir.rest.api.server.storage.IResourcePersistentId;
025import jakarta.annotation.Nonnull;
026import jakarta.annotation.Nullable;
027
028import java.util.Date;
029import java.util.List;
030
031/**
032 * Bulk export history retrieval helper
033 */
034public interface IBulkDataExportHistoryHelper {
035
036        /**
037         * Retrieve history for indicated resource IDs
038         *
039         * @param theResourceType       the type of resources to fetch history for
040         * @param theIdList                             the list of resource ids which history to fetch
041         * @param theRequestPartitionId partition ID for the request
042         * @return bundle provider containing historical versions of the resources
043         */
044        IBundleProvider fetchHistoryForResourceIds(
045                        @Nonnull String theResourceType,
046                        @Nonnull List<IResourcePersistentId<?>> theIdList,
047                        RequestPartitionId theRequestPartitionId,
048                        @Nullable Date theRangeStartInclusive,
049                        @Nonnull Date theRangeEndInclusive);
050}