TBR_R08 (HAPI - Java HL7 API - Generated Structures v2.5 2.3 API)

java.lang.Object
- ca.uhn.hl7v2.model.AbstractStructure
- - ca.uhn.hl7v2.model.AbstractGroup
  - - ca.uhn.hl7v2.model.AbstractMessage
    - - ca.uhn.hl7v2.model.v25.message.TBR_R08

All Implemented Interfaces:

Group, Message, Structure, Visitable, Serializable
```
public class TBR_R08
extends AbstractMessage
```
Represents a TBR_R08 message structure (see chapter ?). This structure contains the following elements:
- 1: MSH (Message Header)
- 2: SFT (Software Segment) optional repeating
- 3: MSA (Message Acknowledgment)
- 4: ERR (Error) optional
- 5: QAK (Query Acknowledgment)
- 6: RDF (Table Row Definition)
- 7: RDT (Table Row Data) repeating
- 8: DSC (Continuation Pointer) optional
See Also:

Serialized Form

Field Summary
- Fields inherited from class ca.uhn.hl7v2.model.AbstractStructure
  log

Constructor Summary

Constructors
Constructor and Description
`TBR_R08()` Creates a new TBR_R08 message with DefaultModelClassFactory.
`TBR_R08(ModelClassFactory factory)` Creates a new TBR_R08 message with custom ModelClassFactory.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`DSC`	`getDSC()` Returns DSC (Continuation Pointer) - creates it if necessary
`ERR`	`getERR()` Returns ERR (Error) - creates it if necessary
`MSA`	`getMSA()` Returns MSA (Message Acknowledgment) - creates it if necessary
`MSH`	`getMSH()` Returns MSH (Message Header) - creates it if necessary
`QAK`	`getQAK()` Returns QAK (Query Acknowledgment) - creates it if necessary
`RDF`	`getRDF()` Returns RDF (Table Row Definition) - creates it if necessary
`RDT`	`getRDT()` Returns the first repetition of RDT (Table Row Data) - creates it if necessary
`RDT`	`getRDT(int rep)` Returns a specific repetition of RDT (Table Row Data) - creates it if necessary
`List<RDT>`	`getRDTAll()` Returns a non-modifiable List containing all current existing repetitions of RDT.
`int`	`getRDTReps()` Returns the number of existing repetitions of RDT
`SFT`	`getSFT()` Returns the first repetition of SFT (Software Segment) - creates it if necessary
`SFT`	`getSFT(int rep)` Returns a specific repetition of SFT (Software Segment) - creates it if necessary
`List<SFT>`	`getSFTAll()` Returns a non-modifiable List containing all current existing repetitions of SFT.
`int`	`getSFTReps()` Returns the number of existing repetitions of SFT
`String`	`getVersion()` Returns "2.5"
`RDT`	`insertRDT(int rep)` Inserts a specific repetition of RDT (Table Row Data)
`void`	`insertRDT(RDT structure, int rep)` Inserts a specific repetition of RDT (Table Row Data)
`SFT`	`insertSFT(int rep)` Inserts a specific repetition of SFT (Software Segment)
`void`	`insertSFT(SFT structure, int rep)` Inserts a specific repetition of SFT (Software Segment)
`RDT`	`removeRDT(int rep)` Removes a specific repetition of RDT (Table Row Data)
`SFT`	`removeSFT(int rep)` Removes a specific repetition of SFT (Software Segment)

Methods inherited from class ca.uhn.hl7v2.model.AbstractMessage
accept, encode, fillResponseHeader, generateACK, generateACK, generateACK, getEncodingCharactersValue, getFieldSeparatorValue, getMessage, getParent, getParser, getValidationContext, initQuickstart, parse, printStructure, printStructure, setParser, toString

Methods inherited from class ca.uhn.hl7v2.model.AbstractGroup
add, add, add, addNonstandardSegment, addNonstandardSegment, clear, currentReps, get, get, getAll, getAllAsList, getClass, getFieldNumForName, getModelClassFactory, getName, getNames, getNonStandardNames, getReps, getTyped, getTyped, insert, insert, insertRepetition, insertRepetition, isChoiceElement, isEmpty, isGroup, isRepeating, isRequired, provideLocation, removeRepetition, tryToInstantiateStructure, visitNestedStructures

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface ca.uhn.hl7v2.model.Group
addNonstandardSegment, addNonstandardSegment, get, get, getAll, getClass, getNames, isChoiceElement, isGroup, isRepeating, isRequired

Methods inherited from interface ca.uhn.hl7v2.model.Structure
getName

Methods inherited from interface ca.uhn.hl7v2.model.Visitable
isEmpty, provideLocation

- Constructor Detail
  - TBR_R08
```
public TBR_R08()
```
    Creates a new TBR_R08 message with DefaultModelClassFactory.
  - TBR_R08
```
public TBR_R08(ModelClassFactory factory)
```
    Creates a new TBR_R08 message with custom ModelClassFactory.
- Method Detail
  - getVersion
```
public String getVersion()
```
    Returns "2.5"
    
    Specified by:
    
    getVersion in interface Message
    
    Overrides:
    
    getVersion in class AbstractMessage
  - getMSH
```
public MSH getMSH()
```
    Returns MSH (Message Header) - creates it if necessary
  - getSFT
```
public SFT getSFT()
```
    Returns the first repetition of SFT (Software Segment) - creates it if necessary
  - getSFT
```
public SFT getSFT(int rep)
```
    Returns a specific repetition of SFT (Software Segment) - creates it if necessary
    
    Parameters:
    
    rep - The repetition index (0-indexed, i.e. the first repetition is at index 0)
    
    Throws:
    
    HL7Exception - if the repetition requested is more than one greater than the number of existing repetitions.
  - getSFTReps
```
public int getSFTReps()
```
    Returns the number of existing repetitions of SFT
  - getSFTAll
```
public List<SFT> getSFTAll()
                    throws HL7Exception
```
    Returns a non-modifiable List containing all current existing repetitions of SFT.
    
    Note that unlike getSFT(), this method will not create any reps if none are already present, so an empty list may be returned.
    
    Throws:
    
    HL7Exception
  - insertSFT
```
public void insertSFT(SFT structure,
                      int rep)
               throws HL7Exception
```
    Inserts a specific repetition of SFT (Software Segment)
    
    Throws:
    
    HL7Exception
    
    See Also:
    
    AbstractGroup#insertRepetition(Structure, int)
  - insertSFT
```
public SFT insertSFT(int rep)
              throws HL7Exception
```
    Inserts a specific repetition of SFT (Software Segment)
    
    Throws:
    
    HL7Exception
    
    See Also:
    
    AbstractGroup#insertRepetition(Structure, int)
  - removeSFT
```
public SFT removeSFT(int rep)
              throws HL7Exception
```
    Removes a specific repetition of SFT (Software Segment)
    
    Throws:
    
    HL7Exception
    
    See Also:
    
    AbstractGroup.removeRepetition(String, int)
  - getMSA
```
public MSA getMSA()
```
    Returns MSA (Message Acknowledgment) - creates it if necessary
  - getERR
```
public ERR getERR()
```
    Returns ERR (Error) - creates it if necessary
  - getQAK
```
public QAK getQAK()
```
    Returns QAK (Query Acknowledgment) - creates it if necessary
  - getRDF
```
public RDF getRDF()
```
    Returns RDF (Table Row Definition) - creates it if necessary
  - getRDT
```
public RDT getRDT()
```
    Returns the first repetition of RDT (Table Row Data) - creates it if necessary
  - getRDT
```
public RDT getRDT(int rep)
```
    Returns a specific repetition of RDT (Table Row Data) - creates it if necessary
    
    Parameters:
    
    rep - The repetition index (0-indexed, i.e. the first repetition is at index 0)
    
    Throws:
    
    HL7Exception - if the repetition requested is more than one greater than the number of existing repetitions.
  - getRDTReps
```
public int getRDTReps()
```
    Returns the number of existing repetitions of RDT
  - getRDTAll
```
public List<RDT> getRDTAll()
                    throws HL7Exception
```
    Returns a non-modifiable List containing all current existing repetitions of RDT.
    
    Note that unlike getRDT(), this method will not create any reps if none are already present, so an empty list may be returned.
    
    Throws:
    
    HL7Exception
  - insertRDT
```
public void insertRDT(RDT structure,
                      int rep)
               throws HL7Exception
```
    Inserts a specific repetition of RDT (Table Row Data)
    
    Throws:
    
    HL7Exception
    
    See Also:
    
    AbstractGroup#insertRepetition(Structure, int)
  - insertRDT
```
public RDT insertRDT(int rep)
              throws HL7Exception
```
    Inserts a specific repetition of RDT (Table Row Data)
    
    Throws:
    
    HL7Exception
    
    See Also:
    
    AbstractGroup#insertRepetition(Structure, int)
  - removeRDT
```
public RDT removeRDT(int rep)
              throws HL7Exception
```
    Removes a specific repetition of RDT (Table Row Data)
    
    Throws:
    
    HL7Exception
    
    See Also:
    
    AbstractGroup.removeRepetition(String, int)
  - getDSC
```
public DSC getDSC()
```
    Returns DSC (Continuation Pointer) - creates it if necessary

Class TBR_R08

Field Summary

Fields inherited from class ca.uhn.hl7v2.model.AbstractStructure

Constructor Summary

Method Summary

Methods inherited from class ca.uhn.hl7v2.model.AbstractMessage

Methods inherited from class ca.uhn.hl7v2.model.AbstractGroup

Methods inherited from class java.lang.Object

Methods inherited from interface ca.uhn.hl7v2.model.Group

Methods inherited from interface ca.uhn.hl7v2.model.Structure

Methods inherited from interface ca.uhn.hl7v2.model.Visitable

Constructor Detail

TBR_R08

TBR_R08

Method Detail

getVersion

getMSH

getSFT

getSFT

getSFTReps

getSFTAll

insertSFT

insertSFT

removeSFT

getMSA

getERR

getQAK

getRDF

getRDT

getRDT

getRDTReps

getRDTAll

insertRDT

insertRDT

removeRDT

getDSC