001/*-
002 * #%L
003 * HAPI FHIR Storage api
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.api.svc;
021
022import ca.uhn.fhir.interceptor.model.RequestPartitionId;
023import ca.uhn.fhir.jpa.api.dao.IFhirResourceDao;
024import ca.uhn.fhir.jpa.searchparam.SearchParameterMap;
025import ca.uhn.fhir.rest.api.CacheControlDirective;
026import ca.uhn.fhir.rest.api.server.IBundleProvider;
027import ca.uhn.fhir.rest.api.server.RequestDetails;
028import ca.uhn.fhir.rest.api.server.storage.IResourcePersistentId;
029import jakarta.annotation.Nullable;
030
031import java.util.List;
032import java.util.Optional;
033
034public interface ISearchCoordinatorSvc<T extends IResourcePersistentId> {
035
036        void cancelAllActiveSearches();
037
038        List<T> getResources(
039                        String theUuid,
040                        int theFrom,
041                        int theTo,
042                        @Nullable RequestDetails theRequestDetails,
043                        RequestPartitionId theRequestPartitionId);
044
045        /**
046         * @param theRequestDetails The RequestDetails associated with the request. If you want to supply a fixed
047         *                          {@link RequestPartitionId} you can use a {@link ca.uhn.fhir.rest.api.server.SystemRequestDetails}
048         *                          and supply it there.
049         */
050        IBundleProvider registerSearch(
051                        IFhirResourceDao<?> theCallingDao,
052                        SearchParameterMap theParams,
053                        String theResourceType,
054                        CacheControlDirective theCacheControlDirective,
055                        @Nullable RequestDetails theRequestDetails);
056
057        /**
058         * Fetch the total number of search results for the given currently executing search, if one is currently executing and
059         * the total is known. Will return empty otherwise
060         */
061        Optional<Integer> getSearchTotal(
062                        String theUuid, @Nullable RequestDetails theRequestDetails, RequestPartitionId theRequestPartitionId);
063}