ca.uhn.hl7v2.model.v251.message

Class INU_U05

java.lang.Object

ca.uhn.hl7v2.model.AbstractStructure

ca.uhn.hl7v2.model.AbstractGroup

ca.uhn.hl7v2.model.AbstractMessage

ca.uhn.hl7v2.model.v251.message.INU_U05

All Implemented Interfaces:

Group, Message, Structure, Serializable

public class INU_U05
extends AbstractMessage

Represents a INU_U05 message structure (see chapter 13.3.5). This structure contains the following elements:

• 1: MSH (Message Header)
• 2: SFT (Software Segment) optional repeating
• 3: EQU (Equipment Detail)
• 4: INV (Inventory Detail) repeating
• 5: ROL (Role) optional

See Also:

Serialized Form

Field Summary

Fields inherited from class ca.uhn.hl7v2.model.AbstractStructure

log

Constructor Summary

Constructors

Constructor and Description
INU_U05() Creates a new INU_U05 message with DefaultModelClassFactory.
INU_U05(ModelClassFactory factory) Creates a new INU_U05 message with custom ModelClassFactory.

Method Summary

Methods

Modifier and Type	Method and Description
EQU	getEQU() Returns EQU (Equipment Detail) - creates it if necessary
INV	getINV() Returns the first repetition of INV (Inventory Detail) - creates it if necessary
INV	getINV(int rep) Returns a specific repetition of INV (Inventory Detail) - creates it if necessary
List<INV>	getINVAll() Returns a non-modifiable List containing all current existing repetitions of INV.
int	getINVReps() Returns the number of existing repetitions of INV
MSH	getMSH() Returns MSH (Message Header) - creates it if necessary
ROL	getROL() Returns ROL (Role) - 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
String	getVersion() Returns "2.5.1"
INV	insertINV(int rep) Inserts a specific repetition of INV (Inventory Detail)
void	insertINV(INV structure, int rep) Inserts a specific repetition of INV (Inventory Detail)
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)
INV	removeINV(int rep) Removes a specific repetition of INV (Inventory Detail)
SFT	removeSFT(int rep) Removes a specific repetition of SFT (Software Segment)

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

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

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

add, add, addNonstandardSegment, addNonstandardSegment, clear, currentReps, get, get, getAll, getAllAsList, getClass, getFieldNumForName, getModelClassFactory, getName, getNames, getNonStandardNames, getReps, getTyped, getTyped, insert, insertRepetition, insertRepetition, isGroup, isRepeating, isRequired, removeRepetition, tryToInstantiateStructure

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, isGroup, isRepeating, isRequired

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

getName

Constructor Detail

INU_U05

public INU_U05()

Creates a new INU_U05 message with DefaultModelClassFactory.

INU_U05

public INU_U05(ModelClassFactory factory)

Creates a new INU_U05 message with custom ModelClassFactory.

Method Detail

getVersion

public String getVersion()

Returns "2.5.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)

getEQU

public EQU getEQU()

Returns EQU (Equipment Detail) - creates it if necessary

getINV

public INV getINV()

Returns the first repetition of INV (Inventory Detail) - creates it if necessary

getINV

public INV getINV(int rep)

Returns a specific repetition of INV (Inventory Detail) - 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.

getINVReps

public int getINVReps()

Returns the number of existing repetitions of INV

getINVAll

public List<INV> getINVAll()
                    throws HL7Exception

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

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

Throws:

HL7Exception

insertINV

public void insertINV(INV structure,
             int rep)
               throws HL7Exception

Inserts a specific repetition of INV (Inventory Detail)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

insertINV

public INV insertINV(int rep)
              throws HL7Exception

Inserts a specific repetition of INV (Inventory Detail)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

removeINV

public INV removeINV(int rep)
              throws HL7Exception

Removes a specific repetition of INV (Inventory Detail)

Throws:

HL7Exception

See Also:

AbstractGroup#removeRepetition(String, int)

getROL

public ROL getROL()

Returns ROL (Role) - creates it if necessary