ca.uhn.hl7v2.model.v24.group

Class ORD_O04_ORDER_TRAY

java.lang.Object

ca.uhn.hl7v2.model.AbstractStructure

ca.uhn.hl7v2.model.AbstractGroup

ca.uhn.hl7v2.model.v24.group.ORD_O04_ORDER_TRAY

All Implemented Interfaces:

Group, Structure, Visitable, Serializable

public class ORD_O04_ORDER_TRAY
extends AbstractGroup

Represents a ORD_O04_ORDER_TRAY 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: ORC (Common Order)
• 2: ODT (Diet Tray Instructions) optional repeating
• 3: 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
ORD_O04_ORDER_TRAY(Group parent, ModelClassFactory factory) Creates a new ORD_O04_ORDER_TRAY group

Method Summary

Modifier and Type	Method and Description
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
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
ODT	getODT() Returns the first repetition of ODT (Diet Tray Instructions) - creates it if necessary
ODT	getODT(int rep) Returns a specific repetition of ODT (Diet Tray Instructions) - creates it if necessary
List<ODT>	getODTAll() Returns a non-modifiable List containing all current existing repetitions of ODT.
int	getODTReps() Returns the number of existing repetitions of ODT
ORC	getORC() Returns ORC (Common Order) - creates it if necessary
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)
ODT	insertODT(int rep) Inserts a specific repetition of ODT (Diet Tray Instructions)
void	insertODT(ODT structure, int rep) Inserts a specific repetition of ODT (Diet Tray Instructions)
NTE	removeNTE(int rep) Removes a specific repetition of NTE (Notes and Comments)
ODT	removeODT(int rep) Removes a specific repetition of ODT (Diet Tray Instructions)

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

accept, 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 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

ORD_O04_ORDER_TRAY

public ORD_O04_ORDER_TRAY(Group parent,
                          ModelClassFactory factory)

Creates a new ORD_O04_ORDER_TRAY group

Method Detail

getVersion

public String getVersion()

Returns "2.4"

getORC

public ORC getORC()

Returns ORC (Common Order) - creates it if necessary

getODT

public ODT getODT()

Returns the first repetition of ODT (Diet Tray Instructions) - creates it if necessary

getODT

public ODT getODT(int rep)

Returns a specific repetition of ODT (Diet Tray Instructions) - 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.

getODTReps

public int getODTReps()

Returns the number of existing repetitions of ODT

getODTAll

public List<ODT> getODTAll()
                    throws HL7Exception

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

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

Throws:

HL7Exception

insertODT

public void insertODT(ODT structure,
                      int rep)
               throws HL7Exception

Inserts a specific repetition of ODT (Diet Tray Instructions)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

insertODT

public ODT insertODT(int rep)
              throws HL7Exception

Inserts a specific repetition of ODT (Diet Tray Instructions)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

removeODT

public ODT removeODT(int rep)
              throws HL7Exception

Removes a specific repetition of ODT (Diet Tray Instructions)

Throws:

HL7Exception

See Also:

AbstractGroup.removeRepetition(String, int)

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)