ca.uhn.hl7v2.model.v281.group

Class ORL_O44_SPECIMEN_SHIPMENT

java.lang.Object

ca.uhn.hl7v2.model.AbstractStructure

ca.uhn.hl7v2.model.AbstractGroup

ca.uhn.hl7v2.model.v281.group.ORL_O44_SPECIMEN_SHIPMENT

All Implemented Interfaces:

Group, Structure, Visitable, Serializable

public class ORL_O44_SPECIMEN_SHIPMENT
extends AbstractGroup

Represents a ORL_O44_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: ORL_O44_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
ORL_O44_SPECIMEN_SHIPMENT(Group parent, ModelClassFactory factory) Creates a new ORL_O44_SPECIMEN_SHIPMENT group

Method Summary

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

ORL_O44_SPECIMEN_SHIPMENT

public ORL_O44_SPECIMEN_SHIPMENT(Group parent,
                                 ModelClassFactory factory)

Creates a new ORL_O44_SPECIMEN_SHIPMENT group

Method Detail

getVersion

public String getVersion()

Returns "2.8.1"

getSHP

public SHP getSHP()

Returns SHP (Shipment) - creates it if necessary

getPACKAGE

public ORL_O44_PACKAGE getPACKAGE()

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

getPACKAGE

public ORL_O44_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<ORL_O44_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(ORL_O44_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 ORL_O44_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 ORL_O44_PACKAGE removePACKAGE(int rep)
                              throws HL7Exception

Removes a specific repetition of PACKAGE (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup.removeRepetition(String, int)