001/*-
002 * #%L
003 * HAPI FHIR Storage api
004 * %%
005 * Copyright (C) 2014 - 2024 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.api.svc;
021
022import ca.uhn.fhir.interceptor.model.RequestPartitionId;
023import ca.uhn.fhir.jpa.api.pid.IResourcePidStream;
024import jakarta.annotation.Nonnull;
025import jakarta.annotation.Nullable;
026
027import java.util.Date;
028
029public interface IGoldenResourceSearchSvc {
030
031        /**
032         * Fetches a cursor of resource IDs for golden resources of the given type.
033         *
034         * @param theStart The start of the date range, must be inclusive.
035         * @param theEnd   The end of the date range, should be exclusive.
036         * @param theRequestPartitionId The request partition ID (may be <code>null</code> on nonpartitioned systems)
037         * @param theResourceType the type of resource.
038         */
039        IResourcePidStream fetchGoldenResourceIdStream(
040                        Date theStart,
041                        Date theEnd,
042                        @Nullable RequestPartitionId theRequestPartitionId,
043                        @Nonnull String theResourceType);
044}