ca.uhn.hl7v2.model.v24.group

Class OML_O21_ORDER_GENERAL

java.lang.Object

ca.uhn.hl7v2.model.AbstractStructure

ca.uhn.hl7v2.model.AbstractGroup

ca.uhn.hl7v2.model.v24.group.OML_O21_ORDER_GENERAL

All Implemented Interfaces:

Group, Structure, Serializable

public class OML_O21_ORDER_GENERAL
extends AbstractGroup

Represents a OML_O21_ORDER_GENERAL 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: OML_O21_CONTAINER_1 (a Group object) optional
• 2: OML_O21_ORDER (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
OML_O21_ORDER_GENERAL(Group parent, ModelClassFactory factory) Creates a new OML_O21_ORDER_GENERAL group

Method Summary

Methods

Modifier and Type	Method and Description
OML_O21_CONTAINER_1	getCONTAINER_1() Returns CONTAINER_1 (a Group object) - creates it if necessary
OML_O21_ORDER	getORDER() Returns the first repetition of ORDER (a Group object) - creates it if necessary
OML_O21_ORDER	getORDER(int rep) Returns a specific repetition of ORDER (a Group object) - creates it if necessary
List<OML_O21_ORDER>	getORDERAll() Returns a non-modifiable List containing all current existing repetitions of ORDER.
int	getORDERReps() Returns the number of existing repetitions of ORDER
String	getVersion() Returns "2.4"
OML_O21_ORDER	insertORDER(int rep) Inserts a specific repetition of ORDER (a Group object)
void	insertORDER(OML_O21_ORDER structure, int rep) Inserts a specific repetition of ORDER (a Group object)
OML_O21_ORDER	removeORDER(int rep) Removes a specific repetition of ORDER (a Group object)

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

OML_O21_ORDER_GENERAL

public OML_O21_ORDER_GENERAL(Group parent,
                     ModelClassFactory factory)

Creates a new OML_O21_ORDER_GENERAL group

Method Detail

getVersion

public String getVersion()

Returns "2.4"

getCONTAINER_1

public OML_O21_CONTAINER_1 getCONTAINER_1()

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

getORDER

public OML_O21_ORDER getORDER()

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

getORDER

public OML_O21_ORDER getORDER(int rep)

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

getORDERReps

public int getORDERReps()

Returns the number of existing repetitions of ORDER

getORDERAll

public List<OML_O21_ORDER> getORDERAll()
                                throws HL7Exception

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

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

Throws:

HL7Exception

insertORDER

public void insertORDER(OML_O21_ORDER structure,
               int rep)
                 throws HL7Exception

Inserts a specific repetition of ORDER (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

insertORDER

public OML_O21_ORDER insertORDER(int rep)
                          throws HL7Exception

Inserts a specific repetition of ORDER (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

removeORDER

public OML_O21_ORDER removeORDER(int rep)
                          throws HL7Exception

Removes a specific repetition of ORDER (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup.removeRepetition(String, int)