ca.uhn.hl7v2.model.v27.group

Class OML_O39_SPECIMEN_SHIPMENT

java.lang.Object

ca.uhn.hl7v2.model.AbstractStructure

ca.uhn.hl7v2.model.AbstractGroup

ca.uhn.hl7v2.model.v27.group.OML_O39_SPECIMEN_SHIPMENT

All Implemented Interfaces:

Group, Structure, Visitable, Serializable

public class OML_O39_SPECIMEN_SHIPMENT
extends AbstractGroup

Represents a OML_O39_SPECIMEN_SHIPMENT 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: SHP (Shipment)
• 2: OML_O39_SHIPMENT_OBSERVATION (a Group object) optional repeating
• 3: OML_O39_PACKAGE (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_O39_SPECIMEN_SHIPMENT(Group parent, ModelClassFactory factory) Creates a new OML_O39_SPECIMEN_SHIPMENT group

Method Summary

Modifier and Type	Method and Description
OML_O39_PACKAGE	getPACKAGE() Returns the first repetition of PACKAGE (a Group object) - creates it if necessary
OML_O39_PACKAGE	getPACKAGE(int rep) Returns a specific repetition of PACKAGE (a Group object) - creates it if necessary
List<OML_O39_PACKAGE>	getPACKAGEAll() Returns a non-modifiable List containing all current existing repetitions of PACKAGE.
int	getPACKAGEReps() Returns the number of existing repetitions of PACKAGE
OML_O39_SHIPMENT_OBSERVATION	getSHIPMENT_OBSERVATION() Returns the first repetition of SHIPMENT_OBSERVATION (a Group object) - creates it if necessary
OML_O39_SHIPMENT_OBSERVATION	getSHIPMENT_OBSERVATION(int rep) Returns a specific repetition of SHIPMENT_OBSERVATION (a Group object) - creates it if necessary
List<OML_O39_SHIPMENT_OBSERVATION>	getSHIPMENT_OBSERVATIONAll() Returns a non-modifiable List containing all current existing repetitions of SHIPMENT_OBSERVATION.
int	getSHIPMENT_OBSERVATIONReps() Returns the number of existing repetitions of SHIPMENT_OBSERVATION
SHP	getSHP() Returns SHP (Shipment) - creates it if necessary
String	getVersion() Returns "2.7"
OML_O39_PACKAGE	insertPACKAGE(int rep) Inserts a specific repetition of PACKAGE (a Group object)
void	insertPACKAGE(OML_O39_PACKAGE structure, int rep) Inserts a specific repetition of PACKAGE (a Group object)
OML_O39_SHIPMENT_OBSERVATION	insertSHIPMENT_OBSERVATION(int rep) Inserts a specific repetition of SHIPMENT_OBSERVATION (a Group object)
void	insertSHIPMENT_OBSERVATION(OML_O39_SHIPMENT_OBSERVATION structure, int rep) Inserts a specific repetition of SHIPMENT_OBSERVATION (a Group object)
OML_O39_PACKAGE	removePACKAGE(int rep) Removes a specific repetition of PACKAGE (a Group object)
OML_O39_SHIPMENT_OBSERVATION	removeSHIPMENT_OBSERVATION(int rep) Removes a specific repetition of SHIPMENT_OBSERVATION (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

OML_O39_SPECIMEN_SHIPMENT

public OML_O39_SPECIMEN_SHIPMENT(Group parent,
                                 ModelClassFactory factory)

Creates a new OML_O39_SPECIMEN_SHIPMENT group

Method Detail

getVersion

public String getVersion()

Returns "2.7"

getSHP

public SHP getSHP()

Returns SHP (Shipment) - creates it if necessary

getSHIPMENT_OBSERVATION

public OML_O39_SHIPMENT_OBSERVATION getSHIPMENT_OBSERVATION()

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

getSHIPMENT_OBSERVATION

public OML_O39_SHIPMENT_OBSERVATION getSHIPMENT_OBSERVATION(int rep)

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

getSHIPMENT_OBSERVATIONReps

public int getSHIPMENT_OBSERVATIONReps()

Returns the number of existing repetitions of SHIPMENT_OBSERVATION

getSHIPMENT_OBSERVATIONAll

public List<OML_O39_SHIPMENT_OBSERVATION> getSHIPMENT_OBSERVATIONAll()
                                                              throws HL7Exception

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

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

Throws:

HL7Exception

insertSHIPMENT_OBSERVATION

public void insertSHIPMENT_OBSERVATION(OML_O39_SHIPMENT_OBSERVATION structure,
                                       int rep)
                                throws HL7Exception

Inserts a specific repetition of SHIPMENT_OBSERVATION (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

insertSHIPMENT_OBSERVATION

public OML_O39_SHIPMENT_OBSERVATION insertSHIPMENT_OBSERVATION(int rep)
                                                        throws HL7Exception

Inserts a specific repetition of SHIPMENT_OBSERVATION (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

removeSHIPMENT_OBSERVATION

public OML_O39_SHIPMENT_OBSERVATION removeSHIPMENT_OBSERVATION(int rep)
                                                        throws HL7Exception

Removes a specific repetition of SHIPMENT_OBSERVATION (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup.removeRepetition(String, int)

getPACKAGE

public OML_O39_PACKAGE getPACKAGE()

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

getPACKAGE

public OML_O39_PACKAGE getPACKAGE(int rep)

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

getPACKAGEReps

public int getPACKAGEReps()

Returns the number of existing repetitions of PACKAGE

getPACKAGEAll

public List<OML_O39_PACKAGE> getPACKAGEAll()
                                    throws HL7Exception

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

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

Throws:

HL7Exception

insertPACKAGE

public void insertPACKAGE(OML_O39_PACKAGE structure,
                          int rep)
                   throws HL7Exception

Inserts a specific repetition of PACKAGE (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

insertPACKAGE

public OML_O39_PACKAGE insertPACKAGE(int rep)
                              throws HL7Exception

Inserts a specific repetition of PACKAGE (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

removePACKAGE

public OML_O39_PACKAGE removePACKAGE(int rep)
                              throws HL7Exception

Removes a specific repetition of PACKAGE (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup.removeRepetition(String, int)