Package ca.uhn.hl7v2.model.v23.group

Class ORD_O02_RESPONSE

java.lang.Object

ca.uhn.hl7v2.model.AbstractStructure

ca.uhn.hl7v2.model.AbstractGroup

ca.uhn.hl7v2.model.v23.group.ORD_O02_RESPONSE

All Implemented Interfaces:

Group, Structure, Visitable, Serializable

public class ORD_O02_RESPONSE
extends AbstractGroup

Represents a ORD_O02_RESPONSE 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: ORD_O02_PATIENT (a Group object) optional
• 2: ORD_O02_ORDER_DIET (a Group object) repeating
• 3: ORD_O02_ORDER_TRAY (a Group object) optional repeating

See Also:

• Serialized Form

Field Summary

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

log

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
ORD_O02_ORDER_DIET	getORDER_DIET()	Returns the first repetition of ORDER_DIET (a Group object) - creates it if necessary
ORD_O02_ORDER_DIET	getORDER_DIET(int rep)	Returns a specific repetition of ORDER_DIET (a Group object) - creates it if necessary
List<ORD_O02_ORDER_DIET>	getORDER_DIETAll()	Returns a non-modifiable List containing all current existing repetitions of ORDER_DIET.
int	getORDER_DIETReps()	Returns the number of existing repetitions of ORDER_DIET
ORD_O02_ORDER_TRAY	getORDER_TRAY()	Returns the first repetition of ORDER_TRAY (a Group object) - creates it if necessary
ORD_O02_ORDER_TRAY	getORDER_TRAY(int rep)	Returns a specific repetition of ORDER_TRAY (a Group object) - creates it if necessary
List<ORD_O02_ORDER_TRAY>	getORDER_TRAYAll()	Returns a non-modifiable List containing all current existing repetitions of ORDER_TRAY.
int	getORDER_TRAYReps()	Returns the number of existing repetitions of ORDER_TRAY
ORD_O02_PATIENT	getPATIENT()	Returns PATIENT (a Group object) - creates it if necessary
String	getVersion()	Returns "2.3"
ORD_O02_ORDER_DIET	insertORDER_DIET(int rep)	Inserts a specific repetition of ORDER_DIET (a Group object)
void	insertORDER_DIET(ORD_O02_ORDER_DIET structure, int rep)	Inserts a specific repetition of ORDER_DIET (a Group object)
ORD_O02_ORDER_TRAY	insertORDER_TRAY(int rep)	Inserts a specific repetition of ORDER_TRAY (a Group object)
void	insertORDER_TRAY(ORD_O02_ORDER_TRAY structure, int rep)	Inserts a specific repetition of ORDER_TRAY (a Group object)
ORD_O02_ORDER_DIET	removeORDER_DIET(int rep)	Removes a specific repetition of ORDER_DIET (a Group object)
ORD_O02_ORDER_TRAY	removeORDER_TRAY(int rep)	Removes a specific repetition of ORDER_TRAY (a Group object)

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 Details

ORD_O02_RESPONSE

public ORD_O02_RESPONSE(Group parent,
 ModelClassFactory factory)

Creates a new ORD_O02_RESPONSE group

Method Details

getVersion

public String getVersion()

Returns "2.3"

getPATIENT

public ORD_O02_PATIENT getPATIENT()

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

getORDER_DIET

public ORD_O02_ORDER_DIET getORDER_DIET()

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

getORDER_DIET

public ORD_O02_ORDER_DIET getORDER_DIET(int rep)

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

getORDER_DIETReps

public int getORDER_DIETReps()

Returns the number of existing repetitions of ORDER_DIET

getORDER_DIETAll

public List<ORD_O02_ORDER_DIET> getORDER_DIETAll()
                                          throws HL7Exception

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

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

Throws:

HL7Exception

insertORDER_DIET

public void insertORDER_DIET(ORD_O02_ORDER_DIET structure,
 int rep)
                      throws HL7Exception

Inserts a specific repetition of ORDER_DIET (a Group object)

Throws:

HL7Exception

See Also:

• AbstractGroup#insertRepetition(Structure, int)

insertORDER_DIET

public ORD_O02_ORDER_DIET insertORDER_DIET(int rep)
                                    throws HL7Exception

Inserts a specific repetition of ORDER_DIET (a Group object)

Throws:

HL7Exception

See Also:

• AbstractGroup#insertRepetition(Structure, int)

removeORDER_DIET

public ORD_O02_ORDER_DIET removeORDER_DIET(int rep)
                                    throws HL7Exception

Removes a specific repetition of ORDER_DIET (a Group object)

Throws:

HL7Exception

See Also:

• AbstractGroup.removeRepetition(String, int)

getORDER_TRAY

public ORD_O02_ORDER_TRAY getORDER_TRAY()

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

getORDER_TRAY

public ORD_O02_ORDER_TRAY getORDER_TRAY(int rep)

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

getORDER_TRAYReps

public int getORDER_TRAYReps()

Returns the number of existing repetitions of ORDER_TRAY

getORDER_TRAYAll

public List<ORD_O02_ORDER_TRAY> getORDER_TRAYAll()
                                          throws HL7Exception

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

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

Throws:

HL7Exception

insertORDER_TRAY

public void insertORDER_TRAY(ORD_O02_ORDER_TRAY structure,
 int rep)
                      throws HL7Exception

Inserts a specific repetition of ORDER_TRAY (a Group object)

Throws:

HL7Exception

See Also:

• AbstractGroup#insertRepetition(Structure, int)

insertORDER_TRAY

public ORD_O02_ORDER_TRAY insertORDER_TRAY(int rep)
                                    throws HL7Exception

Inserts a specific repetition of ORDER_TRAY (a Group object)

Throws:

HL7Exception

See Also:

• AbstractGroup#insertRepetition(Structure, int)

removeORDER_TRAY

public ORD_O02_ORDER_TRAY removeORDER_TRAY(int rep)
                                    throws HL7Exception

Removes a specific repetition of ORDER_TRAY (a Group object)

Throws:

HL7Exception

See Also:

• AbstractGroup.removeRepetition(String, int)