ca.uhn.hl7v2.model.v27.group

Class OUL_R23_CONTAINER

java.lang.Object

ca.uhn.hl7v2.model.AbstractStructure

ca.uhn.hl7v2.model.AbstractGroup

ca.uhn.hl7v2.model.v27.group.OUL_R23_CONTAINER

All Implemented Interfaces:

Group, Structure, Visitable, Serializable

public class OUL_R23_CONTAINER
extends AbstractGroup

Represents a OUL_R23_CONTAINER 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: SAC (Specimen Container detail)
• 2: INV (Inventory Detail) optional
• 3: OUL_R23_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
OUL_R23_CONTAINER(Group parent, ModelClassFactory factory) Creates a new OUL_R23_CONTAINER group

Method Summary

Modifier and Type	Method and Description
INV	getINV() Returns INV (Inventory Detail) - creates it if necessary
OUL_R23_ORDER	getORDER() Returns the first repetition of ORDER (a Group object) - creates it if necessary
OUL_R23_ORDER	getORDER(int rep) Returns a specific repetition of ORDER (a Group object) - creates it if necessary
List<OUL_R23_ORDER>	getORDERAll() Returns a non-modifiable List containing all current existing repetitions of ORDER.
int	getORDERReps() Returns the number of existing repetitions of ORDER
SAC	getSAC() Returns SAC (Specimen Container detail) - creates it if necessary
String	getVersion() Returns "2.7"
OUL_R23_ORDER	insertORDER(int rep) Inserts a specific repetition of ORDER (a Group object)
void	insertORDER(OUL_R23_ORDER structure, int rep) Inserts a specific repetition of ORDER (a Group object)
OUL_R23_ORDER	removeORDER(int rep) Removes a specific repetition of ORDER (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 Detail

OUL_R23_CONTAINER

public OUL_R23_CONTAINER(Group parent,
                         ModelClassFactory factory)

Creates a new OUL_R23_CONTAINER group

Method Detail

getVersion

public String getVersion()

Returns "2.7"

getSAC

public SAC getSAC()

Returns SAC (Specimen Container detail) - creates it if necessary

getINV

public INV getINV()

Returns INV (Inventory Detail) - creates it if necessary

getORDER

public OUL_R23_ORDER getORDER()

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

getORDER

public OUL_R23_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<OUL_R23_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(OUL_R23_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 OUL_R23_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 OUL_R23_ORDER removeORDER(int rep)
                          throws HL7Exception

Removes a specific repetition of ORDER (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup.removeRepetition(String, int)