001/*-
002 * #%L
003 * HAPI FHIR Storage api
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;
021
022import ca.uhn.fhir.jpa.model.cross.IBasePersistedResource;
023import org.hl7.fhir.instance.model.api.IBaseResource;
024
025/**
026 * This interface is used by any storage implementations to convert from
027 * persisted database format (independent of the kind of database) and
028 * HAPI FHIR resource model classes.
029 *
030 * Currently only DB->FHIR is enabled through this interface but the aim
031 * eventually is to handle both directions
032 */
033public interface IStorageResourceParser {
034
035        // TODO: JA2 - Remove theForHistoryOperation flag - It toggles adding a bit of extra
036        // metadata but there's no reason to not always just add that, and this would
037        // simplify this interface
038        IBaseResource toResource(IBasePersistedResource theEntity, boolean theForHistoryOperation);
039}