Package org.hl7.fhir.r4.model

Enum Bundle.BundleType

java.lang.Object

java.lang.Enum<Bundle.BundleType>

org.hl7.fhir.r4.model.Bundle.BundleType

All Implemented Interfaces:

Serializable, Comparable<Bundle.BundleType>

Enclosing class:

Bundle

public static enum Bundle.BundleType
extends Enum<Bundle.BundleType>

Enum Constant Summary

Enum Constants

Enum Constant	Description
BATCH	The bundle is a set of actions - intended to be processed by a server as a group of independent actions.
BATCHRESPONSE	The bundle is a batch response.
COLLECTION	The bundle is a set of resources collected into a single package for ease of distribution that imposes no processing obligations or behavioral rules beyond persistence.
DOCUMENT	The bundle is a document.
HISTORY	The bundle is a list of resources from a history interaction on a server.
MESSAGE	The bundle is a message.
NULL	added to help the parsers with the generic types
SEARCHSET	The bundle is a list of resources returned as a result of a search/query interaction, operation, or message.
TRANSACTION	The bundle is a transaction - intended to be processed by a server as an atomic commit.
TRANSACTIONRESPONSE	The bundle is a transaction response.

Method Summary

Modifier and Type	Method	Description
static Bundle.BundleType	fromCode(String codeString)
String	getDefinition()
String	getDisplay()
String	getSystem()
String	toCode()
static Bundle.BundleType	valueOf(String name)	Returns the enum constant of this type with the specified name.
static Bundle.BundleType[]	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

DOCUMENT

public static final Bundle.BundleType DOCUMENT

The bundle is a document. The first resource is a Composition.

MESSAGE

public static final Bundle.BundleType MESSAGE

The bundle is a message. The first resource is a MessageHeader.

TRANSACTION

public static final Bundle.BundleType TRANSACTION

The bundle is a transaction - intended to be processed by a server as an atomic commit.

TRANSACTIONRESPONSE

public static final Bundle.BundleType TRANSACTIONRESPONSE

The bundle is a transaction response. Because the response is a transaction response, the transaction has succeeded, and all responses are error free.

BATCH

public static final Bundle.BundleType BATCH

The bundle is a set of actions - intended to be processed by a server as a group of independent actions.

BATCHRESPONSE

public static final Bundle.BundleType BATCHRESPONSE

The bundle is a batch response. Note that as a batch, some responses may indicate failure and others success.

HISTORY

public static final Bundle.BundleType HISTORY

The bundle is a list of resources from a history interaction on a server.

SEARCHSET

public static final Bundle.BundleType SEARCHSET

The bundle is a list of resources returned as a result of a search/query interaction, operation, or message.

COLLECTION

public static final Bundle.BundleType COLLECTION

The bundle is a set of resources collected into a single package for ease of distribution that imposes no processing obligations or behavioral rules beyond persistence.

NULL

public static final Bundle.BundleType NULL

added to help the parsers with the generic types

Method Detail

values

public static Bundle.BundleType[] 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 (Bundle.BundleType c : Bundle.BundleType.values())
    System.out.println(c);

Returns:

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

valueOf

public static Bundle.BundleType 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

fromCode

public static Bundle.BundleType fromCode(String codeString)
                                  throws org.hl7.fhir.exceptions.FHIRException

Throws:

org.hl7.fhir.exceptions.FHIRException

toCode

public String toCode()

getSystem

public String getSystem()

getDefinition

public String getDefinition()

getDisplay

public String getDisplay()