ca.uhn.hl7v2.model.v281.message

Class OSM_R26

java.lang.Object

ca.uhn.hl7v2.model.AbstractStructure

ca.uhn.hl7v2.model.AbstractGroup

ca.uhn.hl7v2.model.AbstractMessage

ca.uhn.hl7v2.model.v281.message.OSM_R26

All Implemented Interfaces:

Group, Message, Structure, Visitable, Serializable

public class OSM_R26
extends AbstractMessage

Represents a OSM_R26 message structure (see chapter 7.18.1). This structure contains the following elements:

• 1: MSH (Message Header)
• 2: SFT (Software Segment) optional repeating
• 3: UAC (User Authentication Credential Segment) optional
• 4: OSM_R26_SHIPMENT (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() Creates a new OSM_R26 message with DefaultModelClassFactory.
OSM_R26(ModelClassFactory factory) Creates a new OSM_R26 message with custom ModelClassFactory.

Method Summary

Modifier and Type	Method and Description
MSH	getMSH() Returns MSH (Message Header) - creates it if necessary
SFT	getSFT() Returns the first repetition of SFT (Software Segment) - creates it if necessary
SFT	getSFT(int rep) Returns a specific repetition of SFT (Software Segment) - creates it if necessary
List<SFT>	getSFTAll() Returns a non-modifiable List containing all current existing repetitions of SFT.
int	getSFTReps() Returns the number of existing repetitions of SFT
OSM_R26_SHIPMENT	getSHIPMENT() Returns the first repetition of SHIPMENT (a Group object) - creates it if necessary
OSM_R26_SHIPMENT	getSHIPMENT(int rep) Returns a specific repetition of SHIPMENT (a Group object) - creates it if necessary
List<OSM_R26_SHIPMENT>	getSHIPMENTAll() Returns a non-modifiable List containing all current existing repetitions of SHIPMENT.
int	getSHIPMENTReps() Returns the number of existing repetitions of SHIPMENT
UAC	getUAC() Returns UAC (User Authentication Credential Segment) - creates it if necessary
String	getVersion() Returns "2.8.1"
SFT	insertSFT(int rep) Inserts a specific repetition of SFT (Software Segment)
void	insertSFT(SFT structure, int rep) Inserts a specific repetition of SFT (Software Segment)
OSM_R26_SHIPMENT	insertSHIPMENT(int rep) Inserts a specific repetition of SHIPMENT (a Group object)
void	insertSHIPMENT(OSM_R26_SHIPMENT structure, int rep) Inserts a specific repetition of SHIPMENT (a Group object)
SFT	removeSFT(int rep) Removes a specific repetition of SFT (Software Segment)
OSM_R26_SHIPMENT	removeSHIPMENT(int rep) Removes a specific repetition of SHIPMENT (a Group object)

Methods inherited from class ca.uhn.hl7v2.model.AbstractMessage

accept, encode, fillResponseHeader, generateACK, generateACK, generateACK, getEncodingCharactersValue, getFieldSeparatorValue, getMessage, getParent, getParser, getValidationContext, initQuickstart, parse, printStructure, printStructure, setParser, toString

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, provideLocation, removeRepetition, tryToInstantiateStructure, visitNestedStructures

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface ca.uhn.hl7v2.model.Group

addNonstandardSegment, addNonstandardSegment, get, get, getAll, getClass, getNames, isChoiceElement, isGroup, isRepeating, isRequired

Methods inherited from interface ca.uhn.hl7v2.model.Structure

getName

Methods inherited from interface ca.uhn.hl7v2.model.Visitable

isEmpty, provideLocation

Constructor Detail

OSM_R26

public OSM_R26()

Creates a new OSM_R26 message with DefaultModelClassFactory.

OSM_R26

public OSM_R26(ModelClassFactory factory)

Creates a new OSM_R26 message with custom ModelClassFactory.

Method Detail

getVersion

public String getVersion()

Returns "2.8.1"

Specified by:

getVersion in interface Message

Overrides:

getVersion in class AbstractMessage

getMSH

public MSH getMSH()

Returns MSH (Message Header) - creates it if necessary

getSFT

public SFT getSFT()

Returns the first repetition of SFT (Software Segment) - creates it if necessary

getSFT

public SFT getSFT(int rep)

Returns a specific repetition of SFT (Software Segment) - 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.

getSFTReps

public int getSFTReps()

Returns the number of existing repetitions of SFT

getSFTAll

public List<SFT> getSFTAll()
                    throws HL7Exception

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

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

Throws:

HL7Exception

insertSFT

public void insertSFT(SFT structure,
                      int rep)
               throws HL7Exception

Inserts a specific repetition of SFT (Software Segment)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

insertSFT

public SFT insertSFT(int rep)
              throws HL7Exception

Inserts a specific repetition of SFT (Software Segment)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

removeSFT

public SFT removeSFT(int rep)
              throws HL7Exception

Removes a specific repetition of SFT (Software Segment)

Throws:

HL7Exception

See Also:

AbstractGroup.removeRepetition(String, int)

getUAC

public UAC getUAC()

Returns UAC (User Authentication Credential Segment) - creates it if necessary

getSHIPMENT

public OSM_R26_SHIPMENT getSHIPMENT()

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

getSHIPMENT

public OSM_R26_SHIPMENT getSHIPMENT(int rep)

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

getSHIPMENTReps

public int getSHIPMENTReps()

Returns the number of existing repetitions of SHIPMENT

getSHIPMENTAll

public List<OSM_R26_SHIPMENT> getSHIPMENTAll()
                                      throws HL7Exception

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

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

Throws:

HL7Exception

insertSHIPMENT

public void insertSHIPMENT(OSM_R26_SHIPMENT structure,
                           int rep)
                    throws HL7Exception

Inserts a specific repetition of SHIPMENT (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

insertSHIPMENT

public OSM_R26_SHIPMENT insertSHIPMENT(int rep)
                                throws HL7Exception

Inserts a specific repetition of SHIPMENT (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

removeSHIPMENT

public OSM_R26_SHIPMENT removeSHIPMENT(int rep)
                                throws HL7Exception

Removes a specific repetition of SHIPMENT (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup.removeRepetition(String, int)