Package ca.uhn.hl7v2.model.v251.message

Class LSU_U12

java.lang.Object

ca.uhn.hl7v2.model.AbstractStructure

ca.uhn.hl7v2.model.AbstractGroup

ca.uhn.hl7v2.model.AbstractMessage

ca.uhn.hl7v2.model.v251.message.LSU_U12

All Implemented Interfaces:

Group, Message, Structure, Visitable, Serializable

public class LSU_U12
extends AbstractMessage

Represents a LSU_U12 message structure (see chapter 13.3.12). This structure contains the following elements:

• 1: MSH (Message Header)
• 2: SFT (Software Segment) optional repeating
• 3: EQU (Equipment Detail)
• 4: EQP (Equipment/log Service) 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	Description
LSU_U12()	Creates a new LSU_U12 message with DefaultModelClassFactory.
LSU_U12(ModelClassFactory factory)	Creates a new LSU_U12 message with custom ModelClassFactory.

Method Summary

Modifier and Type	Method	Description
EQP	getEQP()	Returns the first repetition of EQP (Equipment/log Service) - creates it if necessary
EQP	getEQP(int rep)	Returns a specific repetition of EQP (Equipment/log Service) - creates it if necessary
List<EQP>	getEQPAll()	Returns a non-modifiable List containing all current existing repetitions of EQP.
int	getEQPReps()	Returns the number of existing repetitions of EQP
EQU	getEQU()	Returns EQU (Equipment Detail) - creates it if necessary
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"
EQP	insertEQP(int rep)	Inserts a specific repetition of EQP (Equipment/log Service)
void	insertEQP(EQP structure, int rep)	Inserts a specific repetition of EQP (Equipment/log Service)
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)
EQP	removeEQP(int rep)	Removes a specific repetition of EQP (Equipment/log Service)
SFT	removeSFT(int rep)	Removes a specific repetition of SFT (Software Segment)

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

accept, copy, 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 Details

LSU_U12

public LSU_U12()

Creates a new LSU_U12 message with DefaultModelClassFactory.

LSU_U12

public LSU_U12(ModelClassFactory factory)

Creates a new LSU_U12 message with custom ModelClassFactory.

Method Details

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

getEQP

public EQP getEQP()

Returns the first repetition of EQP (Equipment/log Service) - creates it if necessary

getEQP

public EQP getEQP(int rep)

Returns a specific repetition of EQP (Equipment/log Service) - 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.

getEQPReps

public int getEQPReps()

Returns the number of existing repetitions of EQP

getEQPAll

public List<EQP> getEQPAll()
                    throws HL7Exception

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

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

Throws:

HL7Exception

insertEQP

public void insertEQP(EQP structure,
 int rep)
               throws HL7Exception

Inserts a specific repetition of EQP (Equipment/log Service)

Throws:

HL7Exception

See Also:

• AbstractGroup#insertRepetition(Structure, int)

insertEQP

public EQP insertEQP(int rep)
              throws HL7Exception

Inserts a specific repetition of EQP (Equipment/log Service)

Throws:

HL7Exception

See Also:

• AbstractGroup#insertRepetition(Structure, int)

removeEQP

public EQP removeEQP(int rep)
              throws HL7Exception

Removes a specific repetition of EQP (Equipment/log Service)

Throws:

HL7Exception

See Also:

• AbstractGroup.removeRepetition(String, int)

getROL

public ROL getROL()

Returns ROL (Role) - creates it if necessary