001package ca.uhn.fhir.context.api;
002
003/*
004 * #%L
005 * HAPI FHIR - Core Library
006 * %%
007 * Copyright (C) 2014 - 2023 Smile CDR, Inc.
008 * %%
009 * Licensed under the Apache License, Version 2.0 (the "License");
010 * you may not use this file except in compliance with the License.
011 * You may obtain a copy of the License at
012 *
013 *      http://www.apache.org/licenses/LICENSE-2.0
014 *
015 * Unless required by applicable law or agreed to in writing, software
016 * distributed under the License is distributed on an "AS IS" BASIS,
017 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
018 * See the License for the specific language governing permissions and
019 * limitations under the License.
020 * #L%
021 */
022
023import java.util.Set;
024
025import ca.uhn.fhir.model.api.Include;
026import ca.uhn.fhir.util.ResourceReferenceInfo;
027
028/**
029 * Created by Bill de Beaubien on 3/4/2015.
030 *
031 * Controls how bundles decide whether referenced resources should be included
032 */
033public enum BundleInclusionRule {
034        
035        /**
036         * Decision is based on whether the resource's Include is in the IncludeSet (e.g. DiagnosticReport.result). Note that the resource has to be populated to be included.
037         *
038         * This is the default behavior
039         */
040        BASED_ON_INCLUDES {
041                @Override
042                public boolean shouldIncludeReferencedResource(ResourceReferenceInfo theReferenceInfo, Set<Include> theIncludes) {
043                        return theReferenceInfo.matchesIncludeSet(theIncludes);
044                }
045        },
046
047        /**
048         * Decision is based on whether the resource reference is set to a populated resource (in which case its included) or just an id (in which case it's not included)
049         *
050         * This is the original HAPI behavior
051         */
052        BASED_ON_RESOURCE_PRESENCE {
053                @Override
054                public boolean shouldIncludeReferencedResource(ResourceReferenceInfo theReferenceInfo, Set<Include> theIncludes) {
055                        return true;
056                }
057        };
058
059        public abstract boolean shouldIncludeReferencedResource(ResourceReferenceInfo theReferenceInfo, Set<Include> theIncludes);
060}