ca.uhn.hl7v2.model.v281.group

Class OSM_R26_SHIPMENT

java.lang.Object

ca.uhn.hl7v2.model.AbstractStructure

ca.uhn.hl7v2.model.AbstractGroup

ca.uhn.hl7v2.model.v281.group.OSM_R26_SHIPMENT

All Implemented Interfaces:

Group, Structure, Visitable, Serializable

public class OSM_R26_SHIPMENT
extends AbstractGroup

Represents a OSM_R26_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: PRT (Participation Information) repeating
• 3: OSM_R26_SHIPPING_OBSERVATION (a Group object) optional repeating
• 4: OSM_R26_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
OSM_R26_SHIPMENT(Group parent, ModelClassFactory factory) Creates a new OSM_R26_SHIPMENT group

Method Summary

Modifier and Type	Method and Description
OSM_R26_PACKAGE	getPACKAGE() Returns the first repetition of PACKAGE (a Group object) - creates it if necessary
OSM_R26_PACKAGE	getPACKAGE(int rep) Returns a specific repetition of PACKAGE (a Group object) - creates it if necessary
List<OSM_R26_PACKAGE>	getPACKAGEAll() Returns a non-modifiable List containing all current existing repetitions of PACKAGE.
int	getPACKAGEReps() Returns the number of existing repetitions of PACKAGE
PRT	getPRT() Returns the first repetition of PRT (Participation Information) - creates it if necessary
PRT	getPRT(int rep) Returns a specific repetition of PRT (Participation Information) - creates it if necessary
List<PRT>	getPRTAll() Returns a non-modifiable List containing all current existing repetitions of PRT.
int	getPRTReps() Returns the number of existing repetitions of PRT
OSM_R26_SHIPPING_OBSERVATION	getSHIPPING_OBSERVATION() Returns the first repetition of SHIPPING_OBSERVATION (a Group object) - creates it if necessary
OSM_R26_SHIPPING_OBSERVATION	getSHIPPING_OBSERVATION(int rep) Returns a specific repetition of SHIPPING_OBSERVATION (a Group object) - creates it if necessary
List<OSM_R26_SHIPPING_OBSERVATION>	getSHIPPING_OBSERVATIONAll() Returns a non-modifiable List containing all current existing repetitions of SHIPPING_OBSERVATION.
int	getSHIPPING_OBSERVATIONReps() Returns the number of existing repetitions of SHIPPING_OBSERVATION
SHP	getSHP() Returns SHP (Shipment) - creates it if necessary
String	getVersion() Returns "2.8.1"
OSM_R26_PACKAGE	insertPACKAGE(int rep) Inserts a specific repetition of PACKAGE (a Group object)
void	insertPACKAGE(OSM_R26_PACKAGE structure, int rep) Inserts a specific repetition of PACKAGE (a Group object)
PRT	insertPRT(int rep) Inserts a specific repetition of PRT (Participation Information)
void	insertPRT(PRT structure, int rep) Inserts a specific repetition of PRT (Participation Information)
OSM_R26_SHIPPING_OBSERVATION	insertSHIPPING_OBSERVATION(int rep) Inserts a specific repetition of SHIPPING_OBSERVATION (a Group object)
void	insertSHIPPING_OBSERVATION(OSM_R26_SHIPPING_OBSERVATION structure, int rep) Inserts a specific repetition of SHIPPING_OBSERVATION (a Group object)
OSM_R26_PACKAGE	removePACKAGE(int rep) Removes a specific repetition of PACKAGE (a Group object)
PRT	removePRT(int rep) Removes a specific repetition of PRT (Participation Information)
OSM_R26_SHIPPING_OBSERVATION	removeSHIPPING_OBSERVATION(int rep) Removes a specific repetition of SHIPPING_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

OSM_R26_SHIPMENT

public OSM_R26_SHIPMENT(Group parent,
                        ModelClassFactory factory)

Creates a new OSM_R26_SHIPMENT group

Method Detail

getVersion

public String getVersion()

Returns "2.8.1"

getSHP

public SHP getSHP()

Returns SHP (Shipment) - creates it if necessary

getPRT

public PRT getPRT()

Returns the first repetition of PRT (Participation Information) - creates it if necessary

getPRT

public PRT getPRT(int rep)

Returns a specific repetition of PRT (Participation Information) - 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.

getPRTReps

public int getPRTReps()

Returns the number of existing repetitions of PRT

getPRTAll

public List<PRT> getPRTAll()
                    throws HL7Exception

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

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

Throws:

HL7Exception

insertPRT

public void insertPRT(PRT structure,
                      int rep)
               throws HL7Exception

Inserts a specific repetition of PRT (Participation Information)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

insertPRT

public PRT insertPRT(int rep)
              throws HL7Exception

Inserts a specific repetition of PRT (Participation Information)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

removePRT

public PRT removePRT(int rep)
              throws HL7Exception

Removes a specific repetition of PRT (Participation Information)

Throws:

HL7Exception

See Also:

AbstractGroup.removeRepetition(String, int)

getSHIPPING_OBSERVATION

public OSM_R26_SHIPPING_OBSERVATION getSHIPPING_OBSERVATION()

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

getSHIPPING_OBSERVATION

public OSM_R26_SHIPPING_OBSERVATION getSHIPPING_OBSERVATION(int rep)

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

getSHIPPING_OBSERVATIONReps

public int getSHIPPING_OBSERVATIONReps()

Returns the number of existing repetitions of SHIPPING_OBSERVATION

getSHIPPING_OBSERVATIONAll

public List<OSM_R26_SHIPPING_OBSERVATION> getSHIPPING_OBSERVATIONAll()
                                                              throws HL7Exception

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

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

Throws:

HL7Exception

insertSHIPPING_OBSERVATION

public void insertSHIPPING_OBSERVATION(OSM_R26_SHIPPING_OBSERVATION structure,
                                       int rep)
                                throws HL7Exception

Inserts a specific repetition of SHIPPING_OBSERVATION (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

insertSHIPPING_OBSERVATION

public OSM_R26_SHIPPING_OBSERVATION insertSHIPPING_OBSERVATION(int rep)
                                                        throws HL7Exception

Inserts a specific repetition of SHIPPING_OBSERVATION (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

removeSHIPPING_OBSERVATION

public OSM_R26_SHIPPING_OBSERVATION removeSHIPPING_OBSERVATION(int rep)
                                                        throws HL7Exception

Removes a specific repetition of SHIPPING_OBSERVATION (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup.removeRepetition(String, int)

getPACKAGE

public OSM_R26_PACKAGE getPACKAGE()

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

getPACKAGE

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

Removes a specific repetition of PACKAGE (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup.removeRepetition(String, int)