001/*-
002 * #%L
003 * HAPI FHIR JPA Server - Master Data Management
004 * %%
005 * Copyright (C) 2014 - 2023 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.mdm.svc;
021
022import ca.uhn.fhir.mdm.api.IMdmLink;
023import ca.uhn.fhir.mdm.api.MdmLinkJson;
024import ca.uhn.fhir.mdm.api.MdmLinkWithRevision;
025import ca.uhn.fhir.mdm.api.MdmLinkWithRevisionJson;
026
027/**
028 * Contract for decoupling API dependency from the base / JPA modules.
029 */
030public interface IMdmModelConverterSvc {
031
032        /**
033         * Creates JSON representation of the provided MDM link
034         *
035         * @param theLink Link to convert
036         * @return Returns the converted link
037         */
038        MdmLinkJson toJson(IMdmLink theLink);
039
040        /**
041         * Creates JSON representation of the provided MDM link with revision data
042         *
043         * @param theMdmLinkRevision Link with revision data to convert
044         * @return Returns the converted link
045         */
046        MdmLinkWithRevisionJson toJson(MdmLinkWithRevision<? extends IMdmLink<?>> theMdmLinkRevision);
047}