ca.uhn.hl7v2.model.v24.message

Class UDM_Q05

java.lang.Object

ca.uhn.hl7v2.model.AbstractStructure

ca.uhn.hl7v2.model.AbstractGroup

ca.uhn.hl7v2.model.AbstractMessage

ca.uhn.hl7v2.model.v24.message.UDM_Q05

All Implemented Interfaces:

Group, Message, Structure, Visitable, Serializable

public class UDM_Q05
extends AbstractMessage

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

• 1: MSH (Message Header)
• 2: URD (Results/update Definition)
• 3: URS (Unsolicited Selection) optional
• 4: DSP (Display Data) repeating
• 5: 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
UDM_Q05() Creates a new UDM_Q05 message with DefaultModelClassFactory.
UDM_Q05(ModelClassFactory factory) Creates a new UDM_Q05 message with custom ModelClassFactory.

Method Summary

Modifier and Type	Method and Description
DSC	getDSC() Returns DSC (Continuation Pointer) - creates it if necessary
DSP	getDSP() Returns the first repetition of DSP (Display Data) - creates it if necessary
DSP	getDSP(int rep) Returns a specific repetition of DSP (Display Data) - creates it if necessary
List<DSP>	getDSPAll() Returns a non-modifiable List containing all current existing repetitions of DSP.
int	getDSPReps() Returns the number of existing repetitions of DSP
MSH	getMSH() Returns MSH (Message Header) - creates it if necessary
URD	getURD() Returns URD (Results/update Definition) - creates it if necessary
URS	getURS() Returns URS (Unsolicited Selection) - creates it if necessary
String	getVersion() Returns "2.4"
void	insertDSP(DSP structure, int rep) Inserts a specific repetition of DSP (Display Data)
DSP	insertDSP(int rep) Inserts a specific repetition of DSP (Display Data)
DSP	removeDSP(int rep) Removes a specific repetition of DSP (Display Data)

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

UDM_Q05

public UDM_Q05()

Creates a new UDM_Q05 message with DefaultModelClassFactory.

UDM_Q05

public UDM_Q05(ModelClassFactory factory)

Creates a new UDM_Q05 message with custom ModelClassFactory.

Method Detail

getVersion

public String getVersion()

Returns "2.4"

Specified by:

getVersion in interface Message

Overrides:

getVersion in class AbstractMessage

getMSH

public MSH getMSH()

Returns MSH (Message Header) - creates it if necessary

getURD

public URD getURD()

Returns URD (Results/update Definition) - creates it if necessary

getURS

public URS getURS()

Returns URS (Unsolicited Selection) - creates it if necessary

getDSP

public DSP getDSP()

Returns the first repetition of DSP (Display Data) - creates it if necessary

getDSP

public DSP getDSP(int rep)

Returns a specific repetition of DSP (Display 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.

getDSPReps

public int getDSPReps()

Returns the number of existing repetitions of DSP

getDSPAll

public List<DSP> getDSPAll()
                    throws HL7Exception

Returns a non-modifiable List containing all current existing repetitions of DSP.

Note that unlike getDSP(), this method will not create any reps if none are already present, so an empty list may be returned.

Throws:

HL7Exception

insertDSP

public void insertDSP(DSP structure,
                      int rep)
               throws HL7Exception

Inserts a specific repetition of DSP (Display Data)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

insertDSP

public DSP insertDSP(int rep)
              throws HL7Exception

Inserts a specific repetition of DSP (Display Data)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

removeDSP

public DSP removeDSP(int rep)
              throws HL7Exception

Removes a specific repetition of DSP (Display Data)

Throws:

HL7Exception

See Also:

AbstractGroup.removeRepetition(String, int)

getDSC

public DSC getDSC()

Returns DSC (Continuation Pointer) - creates it if necessary