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

All Implemented Interfaces:

Group, Message, Structure, Visitable, Serializable
```
public class MFN_M07
extends AbstractMessage
```
Represents a MFN_M07 message structure (see chapter 8.11.1). This structure contains the following elements:
- 1: MSH (Message Header)
- 2: SFT (Software Segment) optional repeating
- 3: UAC (User Authentication Credential Segment) optional
- 4: MFI (Master File Identification)
- 5: MFN_M07_MF_CLIN_STUDY_SCHED (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
`MFN_M07()` Creates a new MFN_M07 message with DefaultModelClassFactory.
`MFN_M07(ModelClassFactory factory)` Creates a new MFN_M07 message with custom ModelClassFactory.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`MFN_M07_MF_CLIN_STUDY_SCHED`	`getMF_CLIN_STUDY_SCHED()` Returns the first repetition of MF_CLIN_STUDY_SCHED (a Group object) - creates it if necessary
`MFN_M07_MF_CLIN_STUDY_SCHED`	`getMF_CLIN_STUDY_SCHED(int rep)` Returns a specific repetition of MF_CLIN_STUDY_SCHED (a Group object) - creates it if necessary
`List<MFN_M07_MF_CLIN_STUDY_SCHED>`	`getMF_CLIN_STUDY_SCHEDAll()` Returns a non-modifiable List containing all current existing repetitions of MF_CLIN_STUDY_SCHED.
`int`	`getMF_CLIN_STUDY_SCHEDReps()` Returns the number of existing repetitions of MF_CLIN_STUDY_SCHED
`MFI`	`getMFI()` Returns MFI (Master File Identification) - 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"
`MFN_M07_MF_CLIN_STUDY_SCHED`	`insertMF_CLIN_STUDY_SCHED(int rep)` Inserts a specific repetition of MF_CLIN_STUDY_SCHED (a Group object)
`void`	`insertMF_CLIN_STUDY_SCHED(MFN_M07_MF_CLIN_STUDY_SCHED structure, int rep)` Inserts a specific repetition of MF_CLIN_STUDY_SCHED (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)
`MFN_M07_MF_CLIN_STUDY_SCHED`	`removeMF_CLIN_STUDY_SCHED(int rep)` Removes a specific repetition of MF_CLIN_STUDY_SCHED (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
  - MFN_M07
```
public MFN_M07()
```
    Creates a new MFN_M07 message with DefaultModelClassFactory.
  - MFN_M07
```
public MFN_M07(ModelClassFactory factory)
```
    Creates a new MFN_M07 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
  - getMFI
```
public MFI getMFI()
```
    Returns MFI (Master File Identification) - creates it if necessary
  - getMF_CLIN_STUDY_SCHED
```
public MFN_M07_MF_CLIN_STUDY_SCHED getMF_CLIN_STUDY_SCHED()
```
    Returns the first repetition of MF_CLIN_STUDY_SCHED (a Group object) - creates it if necessary
  - getMF_CLIN_STUDY_SCHED
```
public MFN_M07_MF_CLIN_STUDY_SCHED getMF_CLIN_STUDY_SCHED(int rep)
```
    Returns a specific repetition of MF_CLIN_STUDY_SCHED (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.
  - getMF_CLIN_STUDY_SCHEDReps
```
public int getMF_CLIN_STUDY_SCHEDReps()
```
    Returns the number of existing repetitions of MF_CLIN_STUDY_SCHED
  - getMF_CLIN_STUDY_SCHEDAll
```
public List<MFN_M07_MF_CLIN_STUDY_SCHED> getMF_CLIN_STUDY_SCHEDAll()
                                                            throws HL7Exception
```
    Returns a non-modifiable List containing all current existing repetitions of MF_CLIN_STUDY_SCHED.
    
    Note that unlike getMF_CLIN_STUDY_SCHED(), this method will not create any reps if none are already present, so an empty list may be returned.
    
    Throws:
    
    HL7Exception
  - insertMF_CLIN_STUDY_SCHED
```
public void insertMF_CLIN_STUDY_SCHED(MFN_M07_MF_CLIN_STUDY_SCHED structure,
                                      int rep)
                               throws HL7Exception
```
    Inserts a specific repetition of MF_CLIN_STUDY_SCHED (a Group object)
    
    Throws:
    
    HL7Exception
    
    See Also:
    
    AbstractGroup#insertRepetition(Structure, int)
  - insertMF_CLIN_STUDY_SCHED
```
public MFN_M07_MF_CLIN_STUDY_SCHED insertMF_CLIN_STUDY_SCHED(int rep)
                                                      throws HL7Exception
```
    Inserts a specific repetition of MF_CLIN_STUDY_SCHED (a Group object)
    
    Throws:
    
    HL7Exception
    
    See Also:
    
    AbstractGroup#insertRepetition(Structure, int)
  - removeMF_CLIN_STUDY_SCHED
```
public MFN_M07_MF_CLIN_STUDY_SCHED removeMF_CLIN_STUDY_SCHED(int rep)
                                                      throws HL7Exception
```
    Removes a specific repetition of MF_CLIN_STUDY_SCHED (a Group object)
    
    Throws:
    
    HL7Exception
    
    See Also:
    
    AbstractGroup.removeRepetition(String, int)

Class MFN_M07

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

MFN_M07

MFN_M07

Method Detail

getVersion

getMSH

getSFT

getSFT

getSFTReps

getSFTAll

insertSFT

insertSFT

removeSFT

getUAC

getMFI

getMF_CLIN_STUDY_SCHED

getMF_CLIN_STUDY_SCHED

getMF_CLIN_STUDY_SCHEDReps

getMF_CLIN_STUDY_SCHEDAll

insertMF_CLIN_STUDY_SCHED

insertMF_CLIN_STUDY_SCHED

removeMF_CLIN_STUDY_SCHED