QBP_E03 (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.QBP_E03

All Implemented Interfaces:

Group, Message, Structure, Visitable, Serializable
```
public class QBP_E03
extends AbstractMessage
```
Represents a QBP_E03 message structure (see chapter 16.3.3). This structure contains the following elements:
- 1: MSH (Message Header)
- 2: SFT (Software Segment) optional repeating
- 3: UAC (User Authentication Credential Segment) optional repeating
- 4: QPD (Query Parameter Definition)
- 5: RCP (Response Control Parameter)
See Also:

Serialized Form

Field Summary
- Fields inherited from class ca.uhn.hl7v2.model.AbstractStructure
  log

Constructor Summary

Constructors
Constructor and Description
`QBP_E03()` Creates a new QBP_E03 message with DefaultModelClassFactory.
`QBP_E03(ModelClassFactory factory)` Creates a new QBP_E03 message with custom ModelClassFactory.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`MSH`	`getMSH()` Returns MSH (Message Header) - creates it if necessary
`QPD`	`getQPD()` Returns QPD (Query Parameter Definition) - creates it if necessary
`RCP`	`getRCP()` Returns RCP (Response Control Parameter) - 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
`UAC`	`getUAC()` Returns the first repetition of UAC (User Authentication Credential Segment) - creates it if necessary
`UAC`	`getUAC(int rep)` Returns a specific repetition of UAC (User Authentication Credential Segment) - creates it if necessary
`List<UAC>`	`getUACAll()` Returns a non-modifiable List containing all current existing repetitions of UAC.
`int`	`getUACReps()` Returns the number of existing repetitions of UAC
`String`	`getVersion()` Returns "2.8.1"
`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)
`UAC`	`insertUAC(int rep)` Inserts a specific repetition of UAC (User Authentication Credential Segment)
`void`	`insertUAC(UAC structure, int rep)` Inserts a specific repetition of UAC (User Authentication Credential Segment)
`SFT`	`removeSFT(int rep)` Removes a specific repetition of SFT (Software Segment)
`UAC`	`removeUAC(int rep)` Removes a specific repetition of UAC (User Authentication Credential 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
  - QBP_E03
```
public QBP_E03()
```
    Creates a new QBP_E03 message with DefaultModelClassFactory.
  - QBP_E03
```
public QBP_E03(ModelClassFactory factory)
```
    Creates a new QBP_E03 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 the first repetition of UAC (User Authentication Credential Segment) - creates it if necessary
  - getUAC
```
public UAC getUAC(int rep)
```
    Returns a specific repetition of UAC (User Authentication Credential 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.
  - getUACReps
```
public int getUACReps()
```
    Returns the number of existing repetitions of UAC
  - getUACAll
```
public List<UAC> getUACAll()
                    throws HL7Exception
```
    Returns a non-modifiable List containing all current existing repetitions of UAC.
    
    Note that unlike getUAC(), this method will not create any reps if none are already present, so an empty list may be returned.
    
    Throws:
    
    HL7Exception
  - insertUAC
```
public void insertUAC(UAC structure,
                      int rep)
               throws HL7Exception
```
    Inserts a specific repetition of UAC (User Authentication Credential Segment)
    
    Throws:
    
    HL7Exception
    
    See Also:
    
    AbstractGroup#insertRepetition(Structure, int)
  - insertUAC
```
public UAC insertUAC(int rep)
              throws HL7Exception
```
    Inserts a specific repetition of UAC (User Authentication Credential Segment)
    
    Throws:
    
    HL7Exception
    
    See Also:
    
    AbstractGroup#insertRepetition(Structure, int)
  - removeUAC
```
public UAC removeUAC(int rep)
              throws HL7Exception
```
    Removes a specific repetition of UAC (User Authentication Credential Segment)
    
    Throws:
    
    HL7Exception
    
    See Also:
    
    AbstractGroup.removeRepetition(String, int)
  - getQPD
```
public QPD getQPD()
```
    Returns QPD (Query Parameter Definition) - creates it if necessary
  - getRCP
```
public RCP getRCP()
```
    Returns RCP (Response Control Parameter) - creates it if necessary

Class QBP_E03

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

QBP_E03

QBP_E03

Method Detail

getVersion

getMSH

getSFT

getSFT

getSFTReps

getSFTAll

insertSFT

insertSFT

removeSFT

getUAC

getUAC

getUACReps

getUACAll

insertUAC

insertUAC

removeUAC

getQPD

getRCP