Enum BundleTypeEnum

java.lang.Object
java.lang.Enum<BundleTypeEnum>
ca.uhn.fhir.model.dstu2.valueset.BundleTypeEnum
All Implemented Interfaces:
Serializable, Comparable<BundleTypeEnum>

public enum BundleTypeEnum extends Enum<BundleTypeEnum>
  • Enum Constant Summary

    Enum Constants
    Enum Constant
    Description
    Display: Batch
    Code Value: batch The bundle is a transaction - intended to be processed by a server as a group of actions.
    Display: Batch Response
    Code Value: batch-response The bundle is a batch response.
    Display: Collection
    Code Value: collection The bundle is a set of resources collected into a single document for ease of distribution.
    Display: Document
    Code Value: document The bundle is a document.
    Display: History List
    Code Value: history The bundle is a list of resources from a history interaction on a server.
    Display: Message
    Code Value: message The bundle is a message.
    Display: Search Results
    Code Value: searchset The bundle is a list of resources returned as a result of a search/query interaction, operation, or message.
    Display: Transaction
    Code Value: transaction The bundle is a transaction - intended to be processed by a server as an atomic commit.
    Display: Transaction Response
    Code Value: transaction-response The bundle is a transaction response.
  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final ca.uhn.fhir.model.api.IValueSetEnumBinder<BundleTypeEnum>
    Converts codes to their respective enumerated values
    static final String
    Identifier for this Value Set:
    static final String
    Name for this Value Set: BundleType
  • Method Summary

    Modifier and Type
    Method
    Description
    forCode(String theCode)
    Returns the enumerated value associated with this code
    Returns the code associated with this enumerated value
    Returns the code system associated with this enumerated value
    Returns the enum constant of this type with the specified name.
    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

    • DOCUMENT

      public static final BundleTypeEnum DOCUMENT
      Display: Document
      Code Value: document The bundle is a document. The first resource is a Composition.
    • MESSAGE

      public static final BundleTypeEnum MESSAGE
      Display: Message
      Code Value: message The bundle is a message. The first resource is a MessageHeader.
    • TRANSACTION

      public static final BundleTypeEnum TRANSACTION
      Display: Transaction
      Code Value: transaction The bundle is a transaction - intended to be processed by a server as an atomic commit.
    • TRANSACTION_RESPONSE

      public static final BundleTypeEnum TRANSACTION_RESPONSE
      Display: Transaction Response
      Code Value: transaction-response The bundle is a transaction response. Because the response is a transaction response, the transactionhas succeeded, and all responses are error free.
    • BATCH

      public static final BundleTypeEnum BATCH
      Display: Batch
      Code Value: batch The bundle is a transaction - intended to be processed by a server as a group of actions.
    • BATCH_RESPONSE

      public static final BundleTypeEnum BATCH_RESPONSE
      Display: Batch Response
      Code Value: batch-response The bundle is a batch response. Note that as a batch, some responses may indicate failure and others success.
    • HISTORY_LIST

      public static final BundleTypeEnum HISTORY_LIST
      Display: History List
      Code Value: history The bundle is a list of resources from a history interaction on a server.
    • SEARCH_RESULTS

      public static final BundleTypeEnum SEARCH_RESULTS
      Display: Search Results
      Code Value: searchset The bundle is a list of resources returned as a result of a search/query interaction, operation, or message.
    • COLLECTION

      public static final BundleTypeEnum COLLECTION
      Display: Collection
      Code Value: collection The bundle is a set of resources collected into a single document for ease of distribution.
  • Field Details

  • Method Details

    • values

      public static BundleTypeEnum[] 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 BundleTypeEnum 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
    • getCode

      public String getCode()
      Returns the code associated with this enumerated value
    • getSystem

      public String getSystem()
      Returns the code system associated with this enumerated value
    • forCode

      public static BundleTypeEnum forCode(String theCode)
      Returns the enumerated value associated with this code