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.dao.search;
021
022import ca.uhn.fhir.jpa.searchparam.SearchParameterMap;
023import ca.uhn.fhir.rest.api.SortSpec;
024import org.hibernate.search.engine.search.sort.dsl.SearchSortFactory;
025import org.hibernate.search.engine.search.sort.dsl.SortFinalStep;
026
027/**
028 * Helper for building freetext sort clauses
029 */
030public interface IHSearchSortHelper {
031
032        SortFinalStep getSortClauses(SearchSortFactory theSortFactory, SortSpec theSort, String theResourceType);
033
034        /**
035         * Given a resource type and a {@link SearchParameterMap}, return true only if all sort terms are supported.
036         *
037         * @param theResourceType The resource type for the query.
038         * @param theParams The {@link SearchParameterMap} being searched with.
039         * @return true if all sort terms are supported, false otherwise.
040         */
041        boolean supportsAllSortTerms(String theResourceType, SearchParameterMap theParams);
042}