001/*-
002 * #%L
003 * HAPI FHIR JPA Server
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.search.reindex;
021
022import ca.uhn.fhir.rest.api.server.RequestDetails;
023import jakarta.annotation.Nullable;
024import org.hl7.fhir.instance.model.api.IBaseParameters;
025import org.hl7.fhir.instance.model.api.IIdType;
026
027import java.util.Set;
028
029public interface IInstanceReindexService {
030
031        /**
032         * Simulate a reindex and return the details about what would change
033         */
034        IBaseParameters reindexDryRun(
035                        RequestDetails theRequestDetails, IIdType theResourceId, @Nullable Set<String> theParameters);
036
037        /**
038         * Perform a reindex on a single resource and return details about what changed
039         */
040        IBaseParameters reindex(RequestDetails theRequestDetails, IIdType theResourceId);
041}