001/*-
002 * #%L
003 * HAPI FHIR - Server Framework
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.rest.api.server.storage;
021
022import org.hl7.fhir.instance.model.api.IIdType;
023
024public interface IResourcePersistentId<T> {
025
026        IResourcePersistentId NOT_FOUND = new NotFoundPid();
027
028        IIdType getAssociatedResourceId();
029
030        IResourcePersistentId<T> setAssociatedResourceId(IIdType theAssociatedResourceId);
031
032        T getId();
033
034        Long getVersion();
035
036        /**
037         * @param theVersion This should only be populated if a specific version is needed. If you want the current version,
038         *                   leave this as <code>null</code>
039         */
040        void setVersion(Long theVersion);
041
042        /**
043         * Note that, like Version, ResourceType is usually not populated.  It is only populated in scenarios where it
044         * is needed downstream.
045         */
046
047        // TODO KHS this is only used by batch.  Consider moving this to a new interface just for batch resource ids.
048        String getResourceType();
049}