ca.uhn.hl7v2.model.v25.message

Class NMQ_N01

java.lang.Object

ca.uhn.hl7v2.model.AbstractStructure

ca.uhn.hl7v2.model.AbstractGroup

ca.uhn.hl7v2.model.AbstractMessage

ca.uhn.hl7v2.model.v25.message.NMQ_N01

All Implemented Interfaces:

Group, Message, Structure, Visitable, Serializable

public class NMQ_N01
extends AbstractMessage

Represents a NMQ_N01 message structure (see chapter 14.3.1). This structure contains the following elements:

• 1: MSH (Message Header)
• 2: SFT (Software Segment) optional repeating
• 3: NMQ_N01_QRY_WITH_DETAIL (a Group object) optional
• 4: NMQ_N01_CLOCK_AND_STATISTICS (a Group object) repeating

See Also:

Serialized Form

Field Summary

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

log

Constructor Summary

Constructors

Constructor and Description
NMQ_N01() Creates a new NMQ_N01 message with DefaultModelClassFactory.
NMQ_N01(ModelClassFactory factory) Creates a new NMQ_N01 message with custom ModelClassFactory.

Method Summary

Methods

Modifier and Type	Method and Description
NMQ_N01_CLOCK_AND_STATISTICS	getCLOCK_AND_STATISTICS() Returns the first repetition of CLOCK_AND_STATISTICS (a Group object) - creates it if necessary
NMQ_N01_CLOCK_AND_STATISTICS	getCLOCK_AND_STATISTICS(int rep) Returns a specific repetition of CLOCK_AND_STATISTICS (a Group object) - creates it if necessary
List<NMQ_N01_CLOCK_AND_STATISTICS>	getCLOCK_AND_STATISTICSAll() Returns a non-modifiable List containing all current existing repetitions of CLOCK_AND_STATISTICS.
int	getCLOCK_AND_STATISTICSReps() Returns the number of existing repetitions of CLOCK_AND_STATISTICS
MSH	getMSH() Returns MSH (Message Header) - creates it if necessary
NMQ_N01_QRY_WITH_DETAIL	getQRY_WITH_DETAIL() Returns QRY_WITH_DETAIL (a Group object) - creates it if necessary
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"
NMQ_N01_CLOCK_AND_STATISTICS	insertCLOCK_AND_STATISTICS(int rep) Inserts a specific repetition of CLOCK_AND_STATISTICS (a Group object)
void	insertCLOCK_AND_STATISTICS(NMQ_N01_CLOCK_AND_STATISTICS structure, int rep) Inserts a specific repetition of CLOCK_AND_STATISTICS (a Group object)
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)
NMQ_N01_CLOCK_AND_STATISTICS	removeCLOCK_AND_STATISTICS(int rep) Removes a specific repetition of CLOCK_AND_STATISTICS (a Group object)
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, setValidationContext, 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

NMQ_N01

public NMQ_N01()

Creates a new NMQ_N01 message with DefaultModelClassFactory.

NMQ_N01

public NMQ_N01(ModelClassFactory factory)

Creates a new NMQ_N01 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)

getQRY_WITH_DETAIL

public NMQ_N01_QRY_WITH_DETAIL getQRY_WITH_DETAIL()

Returns QRY_WITH_DETAIL (a Group object) - creates it if necessary

getCLOCK_AND_STATISTICS

public NMQ_N01_CLOCK_AND_STATISTICS getCLOCK_AND_STATISTICS()

Returns the first repetition of CLOCK_AND_STATISTICS (a Group object) - creates it if necessary

getCLOCK_AND_STATISTICS

public NMQ_N01_CLOCK_AND_STATISTICS getCLOCK_AND_STATISTICS(int rep)

Returns a specific repetition of CLOCK_AND_STATISTICS (a Group object) - 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.

getCLOCK_AND_STATISTICSReps

public int getCLOCK_AND_STATISTICSReps()

Returns the number of existing repetitions of CLOCK_AND_STATISTICS

getCLOCK_AND_STATISTICSAll

public List<NMQ_N01_CLOCK_AND_STATISTICS> getCLOCK_AND_STATISTICSAll()
                                                              throws HL7Exception

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

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

Throws:

HL7Exception

insertCLOCK_AND_STATISTICS

public void insertCLOCK_AND_STATISTICS(NMQ_N01_CLOCK_AND_STATISTICS structure,
                              int rep)
                                throws HL7Exception

Inserts a specific repetition of CLOCK_AND_STATISTICS (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

insertCLOCK_AND_STATISTICS

public NMQ_N01_CLOCK_AND_STATISTICS insertCLOCK_AND_STATISTICS(int rep)
                                                        throws HL7Exception

Inserts a specific repetition of CLOCK_AND_STATISTICS (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

removeCLOCK_AND_STATISTICS

public NMQ_N01_CLOCK_AND_STATISTICS removeCLOCK_AND_STATISTICS(int rep)
                                                        throws HL7Exception

Removes a specific repetition of CLOCK_AND_STATISTICS (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup.removeRepetition(String, int)