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

Class EAR_U08

java.lang.Object

ca.uhn.hl7v2.model.AbstractStructure

ca.uhn.hl7v2.model.AbstractGroup

ca.uhn.hl7v2.model.AbstractMessage

ca.uhn.hl7v2.model.v251.message.EAR_U08

All Implemented Interfaces:

Group, Message, Structure, Visitable, Serializable

public class EAR_U08
extends AbstractMessage

Represents a EAR_U08 message structure (see chapter 13.3.8). This structure contains the following elements:

• 1: MSH (Message Header)
• 2: SFT (Software Segment) optional repeating
• 3: EQU (Equipment Detail)
• 4: EAR_U08_COMMAND_RESPONSE (a Group object) 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
EAR_U08()	Creates a new EAR_U08 message with DefaultModelClassFactory.
EAR_U08(ModelClassFactory factory)	Creates a new EAR_U08 message with custom ModelClassFactory.

Method Summary

Modifier and Type	Method	Description
EAR_U08_COMMAND_RESPONSE	getCOMMAND_RESPONSE()	Returns the first repetition of COMMAND_RESPONSE (a Group object) - creates it if necessary
EAR_U08_COMMAND_RESPONSE	getCOMMAND_RESPONSE(int rep)	Returns a specific repetition of COMMAND_RESPONSE (a Group object) - creates it if necessary
List<EAR_U08_COMMAND_RESPONSE>	getCOMMAND_RESPONSEAll()	Returns a non-modifiable List containing all current existing repetitions of COMMAND_RESPONSE.
int	getCOMMAND_RESPONSEReps()	Returns the number of existing repetitions of COMMAND_RESPONSE
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"
EAR_U08_COMMAND_RESPONSE	insertCOMMAND_RESPONSE(int rep)	Inserts a specific repetition of COMMAND_RESPONSE (a Group object)
void	insertCOMMAND_RESPONSE(EAR_U08_COMMAND_RESPONSE structure, int rep)	Inserts a specific repetition of COMMAND_RESPONSE (a Group object)
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)
EAR_U08_COMMAND_RESPONSE	removeCOMMAND_RESPONSE(int rep)	Removes a specific repetition of COMMAND_RESPONSE (a Group object)
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

EAR_U08

public EAR_U08()

Creates a new EAR_U08 message with DefaultModelClassFactory.

EAR_U08

public EAR_U08(ModelClassFactory factory)

Creates a new EAR_U08 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

getCOMMAND_RESPONSE

public EAR_U08_COMMAND_RESPONSE getCOMMAND_RESPONSE()

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

getCOMMAND_RESPONSE

public EAR_U08_COMMAND_RESPONSE getCOMMAND_RESPONSE(int rep)

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

getCOMMAND_RESPONSEReps

public int getCOMMAND_RESPONSEReps()

Returns the number of existing repetitions of COMMAND_RESPONSE

getCOMMAND_RESPONSEAll

public List<EAR_U08_COMMAND_RESPONSE> getCOMMAND_RESPONSEAll()
                                                      throws HL7Exception

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

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

Throws:

HL7Exception

insertCOMMAND_RESPONSE

public void insertCOMMAND_RESPONSE(EAR_U08_COMMAND_RESPONSE structure,
 int rep)
                            throws HL7Exception

Inserts a specific repetition of COMMAND_RESPONSE (a Group object)

Throws:

HL7Exception

See Also:

• AbstractGroup#insertRepetition(Structure, int)

insertCOMMAND_RESPONSE

public EAR_U08_COMMAND_RESPONSE insertCOMMAND_RESPONSE(int rep)
                                                throws HL7Exception

Inserts a specific repetition of COMMAND_RESPONSE (a Group object)

Throws:

HL7Exception

See Also:

• AbstractGroup#insertRepetition(Structure, int)

removeCOMMAND_RESPONSE

public EAR_U08_COMMAND_RESPONSE removeCOMMAND_RESPONSE(int rep)
                                                throws HL7Exception

Removes a specific repetition of COMMAND_RESPONSE (a Group object)

Throws:

HL7Exception

See Also:

• AbstractGroup.removeRepetition(String, int)

getROL

public ROL getROL()

Returns ROL (Role) - creates it if necessary