EAN_U09 (HAPI - Java HL7 API - Generated Structures v2.8.1 2.3 API)

java.lang.Object
- ca.uhn.hl7v2.model.AbstractStructure
- - ca.uhn.hl7v2.model.AbstractGroup
  - - ca.uhn.hl7v2.model.AbstractMessage
    - - ca.uhn.hl7v2.model.v281.message.EAN_U09

All Implemented Interfaces:

Group, Message, Structure, Visitable, 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: UAC (User Authentication Credential Segment) optional
- 4: EQU (Equipment Detail)
- 5: EAN_U09_NOTIFICATION (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
`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

All Methods Instance Methods Concrete 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
`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
`UAC`	`getUAC()` Returns UAC (User Authentication Credential Segment) - creates it if necessary
`String`	`getVersion()` Returns "2.8.1"
`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
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
  - 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.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
  - 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)

Class EAN_U09

Field Summary

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

Constructor Summary

Method Summary

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

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

Methods inherited from class java.lang.Object

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

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

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

Constructor Detail

EAN_U09

EAN_U09

Method Detail

getVersion

getMSH

getSFT

getSFT

getSFTReps

getSFTAll

insertSFT

insertSFT

removeSFT

getUAC

getEQU

getNOTIFICATION

getNOTIFICATION

getNOTIFICATIONReps

getNOTIFICATIONAll

insertNOTIFICATION

insertNOTIFICATION

removeNOTIFICATION