Package ca.uhn.fhir.jpa.ips.api

Enum ISectionResourceSupplier.InclusionTypeEnum

java.lang.Object

java.lang.Enum<ISectionResourceSupplier.InclusionTypeEnum>

ca.uhn.fhir.jpa.ips.api.ISectionResourceSupplier.InclusionTypeEnum

All Implemented Interfaces:

Serializable, Comparable<ISectionResourceSupplier.InclusionTypeEnum>

Enclosing interface:

ISectionResourceSupplier

public static enum ISectionResourceSupplier.InclusionTypeEnum
extends Enum<ISectionResourceSupplier.InclusionTypeEnum>

This enum specifies how an individual resource entry that is returned by ISectionResourceSupplier.fetchResourcesForSection(IpsContext, IpsSectionContext, RequestDetails) should be included in the resulting IPS document bundle.

Enum Constant Summary

Enum Constants

Enum Constant	Description
EXCLUDE	Do not include this resource in the document
PRIMARY_RESOURCE	The resource should be included in the document bundle and linked to from the Composition via the Composition.section.entry reference.
SECONDARY_RESOURCE	The resource should be included in the document bundle, but not directly linked from the composition.

Method Summary

Modifier and Type	Method	Description
static ISectionResourceSupplier.InclusionTypeEnum	valueOf(String name)	Returns the enum constant of this type with the specified name.
static ISectionResourceSupplier.InclusionTypeEnum[]	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 Details

PRIMARY_RESOURCE

public static final ISectionResourceSupplier.InclusionTypeEnum PRIMARY_RESOURCE

The resource should be included in the document bundle and linked to from the Composition via the Composition.section.entry reference.

SECONDARY_RESOURCE

public static final ISectionResourceSupplier.InclusionTypeEnum SECONDARY_RESOURCE

The resource should be included in the document bundle, but not directly linked from the composition. This typically means that it is referenced by at least one primary resource.

EXCLUDE

public static final ISectionResourceSupplier.InclusionTypeEnum EXCLUDE

Do not include this resource in the document

Method Details

values

public static ISectionResourceSupplier.InclusionTypeEnum[] values()

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

Returns:

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

valueOf

public static ISectionResourceSupplier.InclusionTypeEnum 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