ca.uhn.hl7v2.model.v25.message

Class EAN_U09

java.lang.Object

ca.uhn.hl7v2.model.AbstractStructure

ca.uhn.hl7v2.model.AbstractGroup

ca.uhn.hl7v2.model.AbstractMessage

ca.uhn.hl7v2.model.v25.message.EAN_U09

All Implemented Interfaces:

Group, Message, Structure, Serializable

public class EAN_U09
extends AbstractMessage

Represents a EAN_U09 message structure (see chapter 13.3.9). This structure contains the following elements:

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

Method Summary

Methods

Modifier and Type	Method and Description
EQU	getEQU() Returns EQU (Equipment Detail) - creates it if necessary
MSH	getMSH() Returns MSH (Message Header) - creates it if necessary
EAN_U09_NOTIFICATION	getNOTIFICATION() Returns the first repetition of NOTIFICATION (a Group object) - creates it if necessary
EAN_U09_NOTIFICATION	getNOTIFICATION(int rep) Returns a specific repetition of NOTIFICATION (a Group object) - creates it if necessary
List<EAN_U09_NOTIFICATION>	getNOTIFICATIONAll() Returns a non-modifiable List containing all current existing repetitions of NOTIFICATION.
int	getNOTIFICATIONReps() Returns the number of existing repetitions of NOTIFICATION
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"
void	insertNOTIFICATION(EAN_U09_NOTIFICATION structure, int rep) Inserts a specific repetition of NOTIFICATION (a Group object)
EAN_U09_NOTIFICATION	insertNOTIFICATION(int rep) Inserts a specific repetition of NOTIFICATION (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)
EAN_U09_NOTIFICATION	removeNOTIFICATION(int rep) Removes a specific repetition of NOTIFICATION (a Group object)
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

EAN_U09

public EAN_U09()

Creates a new EAN_U09 message with DefaultModelClassFactory.

EAN_U09

public EAN_U09(ModelClassFactory factory)

Creates a new EAN_U09 message with custom ModelClassFactory.

Method Detail

getVersion

public String getVersion()

Returns "2.5"

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

getNOTIFICATION

public EAN_U09_NOTIFICATION getNOTIFICATION()

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

getNOTIFICATION

public EAN_U09_NOTIFICATION getNOTIFICATION(int rep)

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

getNOTIFICATIONReps

public int getNOTIFICATIONReps()

Returns the number of existing repetitions of NOTIFICATION

getNOTIFICATIONAll

public List<EAN_U09_NOTIFICATION> getNOTIFICATIONAll()
                                              throws HL7Exception

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

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

Throws:

HL7Exception

insertNOTIFICATION

public void insertNOTIFICATION(EAN_U09_NOTIFICATION structure,
                      int rep)
                        throws HL7Exception

Inserts a specific repetition of NOTIFICATION (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

insertNOTIFICATION

public EAN_U09_NOTIFICATION insertNOTIFICATION(int rep)
                                        throws HL7Exception

Inserts a specific repetition of NOTIFICATION (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

removeNOTIFICATION

public EAN_U09_NOTIFICATION removeNOTIFICATION(int rep)
                                        throws HL7Exception

Removes a specific repetition of NOTIFICATION (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup#removeRepetition(String, int)

getROL

public ROL getROL()

Returns ROL (Role) - creates it if necessary