001/*
002 * #%L
003 * HAPI FHIR - Core Library
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.rest.api;
021
022import ca.uhn.fhir.context.api.BundleInclusionRule;
023import ca.uhn.fhir.model.api.Include;
024import ca.uhn.fhir.model.valueset.BundleTypeEnum;
025import org.hl7.fhir.instance.model.api.IBaseResource;
026import org.hl7.fhir.instance.model.api.IPrimitiveType;
027
028import javax.annotation.Nonnull;
029import javax.annotation.Nullable;
030import java.util.ArrayList;
031import java.util.Date;
032import java.util.List;
033import java.util.Set;
034
035/**
036 * This interface should be considered experimental and will likely change in future releases of HAPI. Use with caution!
037 */
038public interface IVersionSpecificBundleFactory {
039
040        void addResourcesToBundle(List<IBaseResource> theResult, BundleTypeEnum theBundleType, String theServerBase, @Nullable BundleInclusionRule theBundleInclusionRule, @Nullable Set<Include> theIncludes);
041
042        void addRootPropertiesToBundle(String theId, @Nonnull BundleLinks theBundleLinks, Integer theTotalResults, IPrimitiveType<Date> theLastUpdated);
043
044        IBaseResource getResourceBundle();
045
046        /**
047         * @deprecated This was deprecated in HAPI FHIR 4.1.0 as it provides duplicate functionality to the {@link #addRootPropertiesToBundle(String, BundleLinks, Integer, IPrimitiveType<Date>)}
048         * and {@link #addResourcesToBundle(List, BundleTypeEnum, String, BundleInclusionRule, Set)} methods
049         */
050        @Deprecated
051        default void initializeBundleFromResourceList(String theAuthor, List<? extends IBaseResource> theResult, String theServerBase, String theCompleteUrl, int theTotalResults, BundleTypeEnum theBundleType) {
052                addTotalResultsToBundle(theResult.size(), theBundleType);
053                addResourcesToBundle(new ArrayList<>(theResult), theBundleType, null, null, null);
054        }
055
056        void initializeWithBundleResource(IBaseResource theResource);
057
058        List<IBaseResource> toListOfResources();
059
060        void addTotalResultsToBundle(Integer theTotalResults, BundleTypeEnum theBundleType);
061}