ca.uhn.hl7v2.model.v231.group
Class NMR_N01_NCKNTENSTNTENSCNTE

java.lang.Object
  ca.uhn.hl7v2.model.AbstractGroup
      ca.uhn.hl7v2.model.v231.group.NMR_N01_NCKNTENSTNTENSCNTE

All Implemented Interfaces:

Group, Structure, Serializable

public class NMR_N01_NCKNTENSTNTENSCNTE
extends AbstractGroup

Represents a NMR_N01_NCKNTENSTNTENSCNTE 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 (NTE - notes and comments segment) optional repeating
• 3: NST (Application control level statistics) optional
• 4: NTE (NTE - notes and comments segment) optional repeating
• 5: NSC (Application status change) optional
• 6: NTE (NTE - notes and comments segment) optional repeating

See Also:

Serialized Form

Constructor Summary

NMR_N01_NCKNTENSTNTENSCNTE(Group parent, ModelClassFactory factory)
Creates a new NMR_N01_NCKNTENSTNTENSCNTE group

Method Summary

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 (NTE - notes and comments segment) - creates it if necessary
NTE	getNTE(int rep) Returns a specific repetition of NTE (NTE - notes and comments segment) - creates it if necessary
NTE	getNTE2() Returns the first repetition of NTE2 (NTE - notes and comments segment) - creates it if necessary
NTE	getNTE2(int rep) Returns a specific repetition of NTE (NTE - notes and comments segment) - creates it if necessary
int	getNTE2Reps() Returns the number of existing repetitions of NTE2
NTE	getNTE3() Returns the first repetition of NTE3 (NTE - notes and comments segment) - creates it if necessary
NTE	getNTE3(int rep) Returns a specific repetition of NTE (NTE - notes and comments segment) - creates it if necessary
int	getNTE3Reps() Returns the number of existing repetitions of NTE3
int	getNTEReps() Returns the number of existing repetitions of NTE
String	getVersion() Returns "2.3.1"
NTE	insertNTE(int rep) Inserts a specific repetition of NTE (NTE - notes and comments segment)
void	insertNTE(NTE structure, int rep) Inserts a specific repetition of NTE (NTE - notes and comments segment)
NTE	insertNTE2(int rep) Inserts a specific repetition of NTE2 (NTE - notes and comments segment)
void	insertNTE2(NTE structure, int rep) Inserts a specific repetition of NTE2 (NTE - notes and comments segment)
NTE	insertNTE3(int rep) Inserts a specific repetition of NTE3 (NTE - notes and comments segment)
void	insertNTE3(NTE structure, int rep) Inserts a specific repetition of NTE3 (NTE - notes and comments segment)
NTE	removeNTE(int rep) Removes a specific repetition of NTE (NTE - notes and comments segment)
NTE	removeNTE2(int rep) Removes a specific repetition of NTE2 (NTE - notes and comments segment)
NTE	removeNTE3(int rep) Removes a specific repetition of NTE3 (NTE - notes and comments segment)

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

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

Methods inherited from class java.lang.Object

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

Constructor Detail

NMR_N01_NCKNTENSTNTENSCNTE

public NMR_N01_NCKNTENSTNTENSCNTE(Group parent,
                                  ModelClassFactory factory)

Creates a new NMR_N01_NCKNTENSTNTENSCNTE group

Method Detail

getVersion

public String getVersion()

Returns "2.3.1"

getNCK

public NCK getNCK()

Returns NCK (System Clock) - creates it if necessary

getNTE

public NTE getNTE()

Returns the first repetition of NTE (NTE - notes and comments segment) - creates it if necessary

getNTE

public NTE getNTE(int rep)

Returns a specific repetition of NTE (NTE - notes and comments 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.

getNTEReps

public int getNTEReps()

Returns the number of existing repetitions of NTE

insertNTE

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

Inserts a specific repetition of NTE (NTE - notes and comments segment)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

insertNTE

public NTE insertNTE(int rep)
              throws HL7Exception

Inserts a specific repetition of NTE (NTE - notes and comments segment)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

removeNTE

public NTE removeNTE(int rep)
              throws HL7Exception

Removes a specific repetition of NTE (NTE - notes and comments segment)

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 (NTE - notes and comments segment) - creates it if necessary

getNTE2

public NTE getNTE2(int rep)

Returns a specific repetition of NTE (NTE - notes and comments 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.

getNTE2Reps

public int getNTE2Reps()

Returns the number of existing repetitions of NTE2

insertNTE2

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

Inserts a specific repetition of NTE2 (NTE - notes and comments segment)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

insertNTE2

public NTE insertNTE2(int rep)
               throws HL7Exception

Inserts a specific repetition of NTE2 (NTE - notes and comments segment)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

removeNTE2

public NTE removeNTE2(int rep)
               throws HL7Exception

Removes a specific repetition of NTE2 (NTE - notes and comments segment)

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 (NTE - notes and comments segment) - creates it if necessary

getNTE3

public NTE getNTE3(int rep)

Returns a specific repetition of NTE (NTE - notes and comments 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.

getNTE3Reps

public int getNTE3Reps()

Returns the number of existing repetitions of NTE3

insertNTE3

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

Inserts a specific repetition of NTE3 (NTE - notes and comments segment)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

insertNTE3

public NTE insertNTE3(int rep)
               throws HL7Exception

Inserts a specific repetition of NTE3 (NTE - notes and comments segment)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

removeNTE3

public NTE removeNTE3(int rep)
               throws HL7Exception

Removes a specific repetition of NTE3 (NTE - notes and comments segment)

Throws:

HL7Exception

See Also:

AbstractGroup.removeRepetition(String, int)