ca.uhn.hl7v2.model.v24.group

Class NMR_N01_CLOCK_AND_STATS_WITH_NOTES_ALT

java.lang.Object

ca.uhn.hl7v2.model.AbstractStructure

ca.uhn.hl7v2.model.AbstractGroup

ca.uhn.hl7v2.model.v24.group.NMR_N01_CLOCK_AND_STATS_WITH_NOTES_ALT

All Implemented Interfaces:

Group, Structure, Serializable

public class NMR_N01_CLOCK_AND_STATS_WITH_NOTES_ALT
extends AbstractGroup

Represents a NMR_N01_CLOCK_AND_STATS_WITH_NOTES_ALT group structure (a Group object). A Group is an ordered collection of message segments that can repeat together or be optionally in/excluded together. This Group contains the following elements:

• 1: NCK (System clock) optional
• 2: NTE (Notes and Comments) optional repeating
• 3: NST (Application control level statistics) optional
• 4: NTE (Notes and Comments) optional repeating
• 5: NSC (Application status change) optional
• 6: NTE (Notes and Comments) optional repeating

See Also:

Serialized Form

Field Summary

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

log

Constructor Summary

Constructors

Constructor and Description
NMR_N01_CLOCK_AND_STATS_WITH_NOTES_ALT(Group parent, ModelClassFactory factory) Creates a new NMR_N01_CLOCK_AND_STATS_WITH_NOTES_ALT group

Method Summary

Methods

Modifier and Type	Method and Description
NCK	getNCK() Returns NCK (System clock) - creates it if necessary
NSC	getNSC() Returns NSC (Application status change) - creates it if necessary
NST	getNST() Returns NST (Application control level statistics) - creates it if necessary
NTE	getNTE() Returns the first repetition of NTE (Notes and Comments) - creates it if necessary
NTE	getNTE(int rep) Returns a specific repetition of NTE (Notes and Comments) - creates it if necessary
NTE	getNTE2() Returns the first repetition of NTE2 (Notes and Comments) - creates it if necessary
NTE	getNTE2(int rep) Returns a specific repetition of NTE (Notes and Comments) - creates it if necessary
List<NTE>	getNTE2All() Returns a non-modifiable List containing all current existing repetitions of NTE2.
int	getNTE2Reps() Returns the number of existing repetitions of NTE2
NTE	getNTE3() Returns the first repetition of NTE3 (Notes and Comments) - creates it if necessary
NTE	getNTE3(int rep) Returns a specific repetition of NTE (Notes and Comments) - creates it if necessary
List<NTE>	getNTE3All() Returns a non-modifiable List containing all current existing repetitions of NTE3.
int	getNTE3Reps() Returns the number of existing repetitions of NTE3
List<NTE>	getNTEAll() Returns a non-modifiable List containing all current existing repetitions of NTE.
int	getNTEReps() Returns the number of existing repetitions of NTE
String	getVersion() Returns "2.4"
NTE	insertNTE(int rep) Inserts a specific repetition of NTE (Notes and Comments)
void	insertNTE(NTE structure, int rep) Inserts a specific repetition of NTE (Notes and Comments)
NTE	insertNTE2(int rep) Inserts a specific repetition of NTE2 (Notes and Comments)
void	insertNTE2(NTE structure, int rep) Inserts a specific repetition of NTE2 (Notes and Comments)
NTE	insertNTE3(int rep) Inserts a specific repetition of NTE3 (Notes and Comments)
void	insertNTE3(NTE structure, int rep) Inserts a specific repetition of NTE3 (Notes and Comments)
NTE	removeNTE(int rep) Removes a specific repetition of NTE (Notes and Comments)
NTE	removeNTE2(int rep) Removes a specific repetition of NTE2 (Notes and Comments)
NTE	removeNTE3(int rep) Removes a specific repetition of NTE3 (Notes and Comments)

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, removeRepetition, tryToInstantiateStructure

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

getMessage, getParent

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

getMessage, getParent

Constructor Detail

NMR_N01_CLOCK_AND_STATS_WITH_NOTES_ALT

public NMR_N01_CLOCK_AND_STATS_WITH_NOTES_ALT(Group parent,
                                      ModelClassFactory factory)

Creates a new NMR_N01_CLOCK_AND_STATS_WITH_NOTES_ALT group

Method Detail

getVersion

public String getVersion()

Returns "2.4"

getNCK

public NCK getNCK()

Returns NCK (System clock) - creates it if necessary

getNTE

public NTE getNTE()

Returns the first repetition of NTE (Notes and Comments) - creates it if necessary

getNTE

public NTE getNTE(int rep)

Returns a specific repetition of NTE (Notes and Comments) - 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.

getNTEReps

public int getNTEReps()

Returns the number of existing repetitions of NTE

getNTEAll

public List<NTE> getNTEAll()
                    throws HL7Exception

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

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

Throws:

HL7Exception

insertNTE

public void insertNTE(NTE structure,
             int rep)
               throws HL7Exception

Inserts a specific repetition of NTE (Notes and Comments)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

insertNTE

public NTE insertNTE(int rep)
              throws HL7Exception

Inserts a specific repetition of NTE (Notes and Comments)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

removeNTE

public NTE removeNTE(int rep)
              throws HL7Exception

Removes a specific repetition of NTE (Notes and Comments)

Throws:

HL7Exception

See Also:

AbstractGroup.removeRepetition(String, int)

getNST

public NST getNST()

Returns NST (Application control level statistics) - creates it if necessary

getNTE2

public NTE getNTE2()

Returns the first repetition of NTE2 (Notes and Comments) - creates it if necessary

getNTE2

public NTE getNTE2(int rep)

Returns a specific repetition of NTE (Notes and Comments) - 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.

getNTE2Reps

public int getNTE2Reps()

Returns the number of existing repetitions of NTE2

getNTE2All

public List<NTE> getNTE2All()
                     throws HL7Exception

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

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

Throws:

HL7Exception

insertNTE2

public void insertNTE2(NTE structure,
              int rep)
                throws HL7Exception

Inserts a specific repetition of NTE2 (Notes and Comments)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

insertNTE2

public NTE insertNTE2(int rep)
               throws HL7Exception

Inserts a specific repetition of NTE2 (Notes and Comments)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

removeNTE2

public NTE removeNTE2(int rep)
               throws HL7Exception

Removes a specific repetition of NTE2 (Notes and Comments)

Throws:

HL7Exception

See Also:

AbstractGroup.removeRepetition(String, int)

getNSC

public NSC getNSC()

Returns NSC (Application status change) - creates it if necessary

getNTE3

public NTE getNTE3()

Returns the first repetition of NTE3 (Notes and Comments) - creates it if necessary

getNTE3

public NTE getNTE3(int rep)

Returns a specific repetition of NTE (Notes and Comments) - 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.

getNTE3Reps

public int getNTE3Reps()

Returns the number of existing repetitions of NTE3

getNTE3All

public List<NTE> getNTE3All()
                     throws HL7Exception

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

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

Throws:

HL7Exception

insertNTE3

public void insertNTE3(NTE structure,
              int rep)
                throws HL7Exception

Inserts a specific repetition of NTE3 (Notes and Comments)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

insertNTE3

public NTE insertNTE3(int rep)
               throws HL7Exception

Inserts a specific repetition of NTE3 (Notes and Comments)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

removeNTE3

public NTE removeNTE3(int rep)
               throws HL7Exception

Removes a specific repetition of NTE3 (Notes and Comments)

Throws:

HL7Exception

See Also:

AbstractGroup.removeRepetition(String, int)