001/*-
002 * #%L
003 * HAPI FHIR JPA Model
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.model.entity;
021
022import jakarta.annotation.Nonnull;
023import jakarta.annotation.Nullable;
024import org.hl7.fhir.instance.model.api.IIdType;
025
026/**
027 * Provides a common interface used to extract Combo Unique ({@link ca.uhn.fhir.jpa.model.entity.ResourceIndexedComboStringUnique})
028 * and Combo Non-Unique ({@link ca.uhn.fhir.jpa.model.entity.ResourceIndexedComboTokenNonUnique}) SearchParameters
029 */
030public interface IResourceIndexComboSearchParameter {
031
032        /**
033         * Will be in the exact form <code>[resourceType]/[id]</code>
034         */
035        @Nullable // if it never got set, e.g. on a row pulled from the DB
036        IIdType getSearchParameterId();
037
038        void setSearchParameterId(@Nonnull IIdType theSearchParameterId);
039
040        String getIndexString();
041
042        ResourceTable getResource();
043
044        void setResource(ResourceTable theResourceTable);
045}