ca.uhn.fhir.context.api

Enum BundleInclusionRule

java.lang.Object

java.lang.Enum<BundleInclusionRule>

ca.uhn.fhir.context.api.BundleInclusionRule

All Implemented Interfaces:

Serializable, Comparable<BundleInclusionRule>

public enum BundleInclusionRule
extends Enum<BundleInclusionRule>

Created by Bill de Beaubien on 3/4/2015. Controls how bundles decide whether referenced resources should be included

Enum Constant Summary

Enum Constants

Enum Constant and Description
BASED_ON_INCLUDES Decision is based on whether the resource's Include is in the IncludeSet (e.g.
BASED_ON_RESOURCE_PRESENCE 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) This is the original HAPI behavior

Method Summary

Modifier and Type	Method and Description
abstract boolean	shouldIncludeReferencedResource(ResourceReferenceInfo theReferenceInfo, Set<Include> theIncludes)
static BundleInclusionRule	valueOf(String name) Returns the enum constant of this type with the specified name.
static BundleInclusionRule[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

BASED_ON_INCLUDES

public static final BundleInclusionRule BASED_ON_INCLUDES

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. This is the default behavior

BASED_ON_RESOURCE_PRESENCE

public static final BundleInclusionRule BASED_ON_RESOURCE_PRESENCE

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) This is the original HAPI behavior

Method Detail

values

public static BundleInclusionRule[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (BundleInclusionRule c : BundleInclusionRule.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static BundleInclusionRule valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

shouldIncludeReferencedResource

public abstract boolean shouldIncludeReferencedResource(ResourceReferenceInfo theReferenceInfo,
                                                        Set<Include> theIncludes)