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

All Implemented Interfaces:

Group, Message, Structure, Visitable, Serializable
```
public class MFK_M01
extends AbstractMessage
```
Represents a MFK_M01 message structure (see chapter 8.4.2). This structure contains the following elements:
- 1: MSH (Message Header)
- 2: SFT (Software Segment) optional repeating
- 3: UAC (User Authentication Credential Segment) optional
- 4: MSA (Message Acknowledgment)
- 5: ERR (Error) optional repeating
- 6: MFI (Master File Identification)
- 7: MFA (Master File Acknowledgment) optional repeating
See Also:

Serialized Form

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

Constructor Summary

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

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ERR`	`getERR()` Returns the first repetition of ERR (Error) - creates it if necessary
`ERR`	`getERR(int rep)` Returns a specific repetition of ERR (Error) - creates it if necessary
`List<ERR>`	`getERRAll()` Returns a non-modifiable List containing all current existing repetitions of ERR.
`int`	`getERRReps()` Returns the number of existing repetitions of ERR
`MFA`	`getMFA()` Returns the first repetition of MFA (Master File Acknowledgment) - creates it if necessary
`MFA`	`getMFA(int rep)` Returns a specific repetition of MFA (Master File Acknowledgment) - creates it if necessary
`List<MFA>`	`getMFAAll()` Returns a non-modifiable List containing all current existing repetitions of MFA.
`int`	`getMFAReps()` Returns the number of existing repetitions of MFA
`MFI`	`getMFI()` Returns MFI (Master File Identification) - creates it if necessary
`MSA`	`getMSA()` Returns MSA (Message Acknowledgment) - creates it if necessary
`MSH`	`getMSH()` Returns MSH (Message Header) - 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 UAC (User Authentication Credential Segment) - creates it if necessary
`String`	`getVersion()` Returns "2.8.1"
`void`	`insertERR(ERR structure, int rep)` Inserts a specific repetition of ERR (Error)
`ERR`	`insertERR(int rep)` Inserts a specific repetition of ERR (Error)
`MFA`	`insertMFA(int rep)` Inserts a specific repetition of MFA (Master File Acknowledgment)
`void`	`insertMFA(MFA structure, int rep)` Inserts a specific repetition of MFA (Master File Acknowledgment)
`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)
`ERR`	`removeERR(int rep)` Removes a specific repetition of ERR (Error)
`MFA`	`removeMFA(int rep)` Removes a specific repetition of MFA (Master File Acknowledgment)
`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
  - MFK_M01
```
public MFK_M01()
```
    Creates a new MFK_M01 message with DefaultModelClassFactory.
  - MFK_M01
```
public MFK_M01(ModelClassFactory factory)
```
    Creates a new MFK_M01 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
  - getMSA
```
public MSA getMSA()
```
    Returns MSA (Message Acknowledgment) - creates it if necessary
  - getERR
```
public ERR getERR()
```
    Returns the first repetition of ERR (Error) - creates it if necessary
  - getERR
```
public ERR getERR(int rep)
```
    Returns a specific repetition of ERR (Error) - 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.
  - getERRReps
```
public int getERRReps()
```
    Returns the number of existing repetitions of ERR
  - getERRAll
```
public List<ERR> getERRAll()
                    throws HL7Exception
```
    Returns a non-modifiable List containing all current existing repetitions of ERR.
    
    Note that unlike getERR(), this method will not create any reps if none are already present, so an empty list may be returned.
    
    Throws:
    
    HL7Exception
  - insertERR
```
public void insertERR(ERR structure,
                      int rep)
               throws HL7Exception
```
    Inserts a specific repetition of ERR (Error)
    
    Throws:
    
    HL7Exception
    
    See Also:
    
    AbstractGroup#insertRepetition(Structure, int)
  - insertERR
```
public ERR insertERR(int rep)
              throws HL7Exception
```
    Inserts a specific repetition of ERR (Error)
    
    Throws:
    
    HL7Exception
    
    See Also:
    
    AbstractGroup#insertRepetition(Structure, int)
  - removeERR
```
public ERR removeERR(int rep)
              throws HL7Exception
```
    Removes a specific repetition of ERR (Error)
    
    Throws:
    
    HL7Exception
    
    See Also:
    
    AbstractGroup.removeRepetition(String, int)
  - getMFI
```
public MFI getMFI()
```
    Returns MFI (Master File Identification) - creates it if necessary
  - getMFA
```
public MFA getMFA()
```
    Returns the first repetition of MFA (Master File Acknowledgment) - creates it if necessary
  - getMFA
```
public MFA getMFA(int rep)
```
    Returns a specific repetition of MFA (Master File Acknowledgment) - 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.
  - getMFAReps
```
public int getMFAReps()
```
    Returns the number of existing repetitions of MFA
  - getMFAAll
```
public List<MFA> getMFAAll()
                    throws HL7Exception
```
    Returns a non-modifiable List containing all current existing repetitions of MFA.
    
    Note that unlike getMFA(), this method will not create any reps if none are already present, so an empty list may be returned.
    
    Throws:
    
    HL7Exception
  - insertMFA
```
public void insertMFA(MFA structure,
                      int rep)
               throws HL7Exception
```
    Inserts a specific repetition of MFA (Master File Acknowledgment)
    
    Throws:
    
    HL7Exception
    
    See Also:
    
    AbstractGroup#insertRepetition(Structure, int)
  - insertMFA
```
public MFA insertMFA(int rep)
              throws HL7Exception
```
    Inserts a specific repetition of MFA (Master File Acknowledgment)
    
    Throws:
    
    HL7Exception
    
    See Also:
    
    AbstractGroup#insertRepetition(Structure, int)
  - removeMFA
```
public MFA removeMFA(int rep)
              throws HL7Exception
```
    Removes a specific repetition of MFA (Master File Acknowledgment)
    
    Throws:
    
    HL7Exception
    
    See Also:
    
    AbstractGroup.removeRepetition(String, int)

Class MFK_M01

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

MFK_M01

MFK_M01

Method Detail

getVersion

getMSH

getSFT

getSFT

getSFTReps

getSFTAll

insertSFT

insertSFT

removeSFT

getUAC

getMSA

getERR

getERR

getERRReps

getERRAll

insertERR

insertERR

removeERR

getMFI

getMFA

getMFA

getMFAReps

getMFAAll

insertMFA

insertMFA

removeMFA