001/*-
002 * #%L
003 * HAPI FHIR - Core Library
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.svcs;
021
022import jakarta.annotation.Nonnull;
023
024import java.util.Collection;
025
026public interface ISearchLimiterSvc {
027
028        /**
029         * Add a resource type to omit from all search results for the named operation.
030         * @param theOperationName operation name (eg: $everything, $export, etc)
031         * @param theResourceType the resource name to omit (eg: Group, List, etc)
032         */
033        void addOmittedResourceType(@Nonnull String theOperationName, @Nonnull String theResourceType);
034
035        /**
036         * Get all omitted resources for the named operation.
037         */
038        Collection<String> getResourcesToOmitForOperationSearches(@Nonnull String theOperationName);
039
040        /**
041         * Remove the resource type from the omission criteria.
042         * @param theOperationName the operation name
043         * @param theResourceType the resource type to remove
044         */
045        void removeOmittedResourceType(@Nonnull String theOperationName, @Nonnull String theResourceType);
046
047        /**
048         * Remove all omitted resource types for the operation.
049         * @param theOperationName the operation name
050         */
051        void removeAllResourcesForOperation(String theOperationName);
052}