ca.uhn.hl7v2.model.v231.message
Class TBR_R08

java.lang.Object
  ca.uhn.hl7v2.model.AbstractGroup
      ca.uhn.hl7v2.model.AbstractMessage
          ca.uhn.hl7v2.model.v231.message.TBR_R08

All Implemented Interfaces:

Group, Message, Structure, Serializable

public class TBR_R08
extends AbstractMessage

Represents a TBR_R08 message structure (see chapter ?). This structure contains the following elements:

• 1: MSH (MSH - message header segment)
• 2: MSA (MSA - message acknowledgment segment)
• 3: ERR (ERR - error segment) optional
• 4: QAK (Query Acknowledgement)
• 5: RDF (RDF - table row definition segment)
• 6: RDT (RDT - table row data segment) repeating
• 7: DSC (DSC - Continuation pointer segment) optional

See Also:

Serialized Form

Constructor Summary

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

DSC	getDSC() Returns DSC (DSC - Continuation pointer segment) - creates it if necessary
ERR	getERR() Returns ERR (ERR - error segment) - creates it if necessary
MSA	getMSA() Returns MSA (MSA - message acknowledgment segment) - creates it if necessary
MSH	getMSH() Returns MSH (MSH - message header segment) - creates it if necessary
QAK	getQAK() Returns QAK (Query Acknowledgement) - creates it if necessary
RDF	getRDF() Returns RDF (RDF - table row definition segment) - creates it if necessary
RDT	getRDT() Returns the first repetition of RDT (RDT - table row data segment) - creates it if necessary
RDT	getRDT(int rep) Returns a specific repetition of RDT (RDT - table row data segment) - creates it if necessary
int	getRDTReps() Returns the number of existing repetitions of RDT
String	getVersion() Returns "2.3.1"
RDT	insertRDT(int rep) Inserts a specific repetition of RDT (RDT - table row data segment)
void	insertRDT(RDT structure, int rep) Inserts a specific repetition of RDT (RDT - table row data segment)
RDT	removeRDT(int rep) Removes a specific repetition of RDT (RDT - table row data segment)

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

encode, generateACK, generateACK, getEncodingCharactersValue, getFieldSeparatorValue, getMessage, getParser, getValidationContext, initQuickstart, parse, printStructure, setParser, setValidationContext, toString

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

add, add, addNonstandardSegment, addNonstandardSegment, clear, currentReps, get, get, getAll, getClass, getModelClassFactory, getName, getNames, getParent, insertRepetition, insertRepetition, isGroup, isRepeating, isRequired, removeRepetition

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, isGroup, isRepeating, isRequired

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

getName, getParent

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.3.1"

Specified by:

getVersion in interface Message

Overrides:

getVersion in class AbstractMessage

getMSH

public MSH getMSH()

Returns MSH (MSH - message header segment) - creates it if necessary

getMSA

public MSA getMSA()

Returns MSA (MSA - message acknowledgment segment) - creates it if necessary

getERR

public ERR getERR()

Returns ERR (ERR - error segment) - creates it if necessary

getQAK

public QAK getQAK()

Returns QAK (Query Acknowledgement) - creates it if necessary

getRDF

public RDF getRDF()

Returns RDF (RDF - table row definition segment) - creates it if necessary

getRDT

public RDT getRDT()

Returns the first repetition of RDT (RDT - table row data segment) - creates it if necessary

getRDT

public RDT getRDT(int rep)

Returns a specific repetition of RDT (RDT - table row data 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.

getRDTReps

public int getRDTReps()

Returns the number of existing repetitions of RDT

insertRDT

public void insertRDT(RDT structure,
                      int rep)
               throws HL7Exception

Inserts a specific repetition of RDT (RDT - table row data segment)

Throws:

HL7Exception

See Also:

AbstractGroup\#insertRepetition(Structure, int)

insertRDT

public RDT insertRDT(int rep)
              throws HL7Exception

Inserts a specific repetition of RDT (RDT - table row data segment)

Throws:

HL7Exception

See Also:

AbstractGroup\#insertRepetition(Structure, int)

removeRDT

public RDT removeRDT(int rep)
              throws HL7Exception

Removes a specific repetition of RDT (RDT - table row data segment)

Throws:

HL7Exception

See Also:

AbstractGroup\#removeRepetition(String, int)

getDSC

public DSC getDSC()

Returns DSC (DSC - Continuation pointer segment) - creates it if necessary