MFR_M05_MF_QUERY (HAPI - Java HL7 API - Generated Structures v2.5 2.3 API)

java.lang.Object
- ca.uhn.hl7v2.model.AbstractStructure
- - ca.uhn.hl7v2.model.AbstractGroup
  - - ca.uhn.hl7v2.model.v25.group.MFR_M05_MF_QUERY

All Implemented Interfaces:

Group, Structure, Visitable, Serializable
```
public class MFR_M05_MF_QUERY
extends AbstractGroup
```
Represents a MFR_M05_MF_QUERY group structure (a Group object). A Group is an ordered collection of message segments that can repeat together or be optionally in/excluded together. This Group contains the following elements:
- 1: MFE (Master File Entry)
- 2: LOC (Location Identification)
- 3: LCH (Location Characteristic) optional repeating
- 4: LRL (Location Relationship) optional repeating
- 5: LDP (Location Department) repeating
- 6: LCH (Location Characteristic) optional repeating
- 7: LCC (Location Charge Code) optional repeating
See Also:

Serialized Form

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

Constructor Summary

Constructors
Constructor and Description

MFR_M05_MF_QUERY(Group parent, ModelClassFactory factory)
Creates a new MFR_M05_MF_QUERY group

Constructors
Constructor and Description
`MFR_M05_MF_QUERY(Group parent, ModelClassFactory factory)` Creates a new MFR_M05_MF_QUERY group

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`LCC`	`getLCC()` Returns the first repetition of LCC (Location Charge Code) - creates it if necessary
`LCC`	`getLCC(int rep)` Returns a specific repetition of LCC (Location Charge Code) - creates it if necessary
`List<LCC>`	`getLCCAll()` Returns a non-modifiable List containing all current existing repetitions of LCC.
`int`	`getLCCReps()` Returns the number of existing repetitions of LCC
`LCH`	`getLCH()` Returns the first repetition of LCH (Location Characteristic) - creates it if necessary
`LCH`	`getLCH(int rep)` Returns a specific repetition of LCH (Location Characteristic) - creates it if necessary
`LCH`	`getLCH2()` Returns the first repetition of LCH2 (Location Characteristic) - creates it if necessary
`LCH`	`getLCH2(int rep)` Returns a specific repetition of LCH (Location Characteristic) - creates it if necessary
`List<LCH>`	`getLCH2All()` Returns a non-modifiable List containing all current existing repetitions of LCH2.
`int`	`getLCH2Reps()` Returns the number of existing repetitions of LCH2
`List<LCH>`	`getLCHAll()` Returns a non-modifiable List containing all current existing repetitions of LCH.
`int`	`getLCHReps()` Returns the number of existing repetitions of LCH
`LDP`	`getLDP()` Returns the first repetition of LDP (Location Department) - creates it if necessary
`LDP`	`getLDP(int rep)` Returns a specific repetition of LDP (Location Department) - creates it if necessary
`List<LDP>`	`getLDPAll()` Returns a non-modifiable List containing all current existing repetitions of LDP.
`int`	`getLDPReps()` Returns the number of existing repetitions of LDP
`LOC`	`getLOC()` Returns LOC (Location Identification) - creates it if necessary
`LRL`	`getLRL()` Returns the first repetition of LRL (Location Relationship) - creates it if necessary
`LRL`	`getLRL(int rep)` Returns a specific repetition of LRL (Location Relationship) - creates it if necessary
`List<LRL>`	`getLRLAll()` Returns a non-modifiable List containing all current existing repetitions of LRL.
`int`	`getLRLReps()` Returns the number of existing repetitions of LRL
`MFE`	`getMFE()` Returns MFE (Master File Entry) - creates it if necessary
`String`	`getVersion()` Returns "2.5"
`LCC`	`insertLCC(int rep)` Inserts a specific repetition of LCC (Location Charge Code)
`void`	`insertLCC(LCC structure, int rep)` Inserts a specific repetition of LCC (Location Charge Code)
`LCH`	`insertLCH(int rep)` Inserts a specific repetition of LCH (Location Characteristic)
`void`	`insertLCH(LCH structure, int rep)` Inserts a specific repetition of LCH (Location Characteristic)
`LCH`	`insertLCH2(int rep)` Inserts a specific repetition of LCH2 (Location Characteristic)
`void`	`insertLCH2(LCH structure, int rep)` Inserts a specific repetition of LCH2 (Location Characteristic)
`LDP`	`insertLDP(int rep)` Inserts a specific repetition of LDP (Location Department)
`void`	`insertLDP(LDP structure, int rep)` Inserts a specific repetition of LDP (Location Department)
`LRL`	`insertLRL(int rep)` Inserts a specific repetition of LRL (Location Relationship)
`void`	`insertLRL(LRL structure, int rep)` Inserts a specific repetition of LRL (Location Relationship)
`LCC`	`removeLCC(int rep)` Removes a specific repetition of LCC (Location Charge Code)
`LCH`	`removeLCH(int rep)` Removes a specific repetition of LCH (Location Characteristic)
`LCH`	`removeLCH2(int rep)` Removes a specific repetition of LCH2 (Location Characteristic)
`LDP`	`removeLDP(int rep)` Removes a specific repetition of LDP (Location Department)
`LRL`	`removeLRL(int rep)` Removes a specific repetition of LRL (Location Relationship)

Methods inherited from class ca.uhn.hl7v2.model.AbstractGroup
accept, 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 ca.uhn.hl7v2.model.AbstractStructure
getMessage, getParent

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface ca.uhn.hl7v2.model.Structure
getMessage, getParent

- Constructor Detail
  - MFR_M05_MF_QUERY
```
public MFR_M05_MF_QUERY(Group parent,
                        ModelClassFactory factory)
```
    Creates a new MFR_M05_MF_QUERY group
- Method Detail
  - getVersion
```
public String getVersion()
```
    Returns "2.5"
  - getMFE
```
public MFE getMFE()
```
    Returns MFE (Master File Entry) - creates it if necessary
  - getLOC
```
public LOC getLOC()
```
    Returns LOC (Location Identification) - creates it if necessary
  - getLCH
```
public LCH getLCH()
```
    Returns the first repetition of LCH (Location Characteristic) - creates it if necessary
  - getLCH
```
public LCH getLCH(int rep)
```
    Returns a specific repetition of LCH (Location Characteristic) - 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.
  - getLCHReps
```
public int getLCHReps()
```
    Returns the number of existing repetitions of LCH
  - getLCHAll
```
public List<LCH> getLCHAll()
                    throws HL7Exception
```
    Returns a non-modifiable List containing all current existing repetitions of LCH.
    
    Note that unlike getLCH(), this method will not create any reps if none are already present, so an empty list may be returned.
    
    Throws:
    
    HL7Exception
  - insertLCH
```
public void insertLCH(LCH structure,
                      int rep)
               throws HL7Exception
```
    Inserts a specific repetition of LCH (Location Characteristic)
    
    Throws:
    
    HL7Exception
    
    See Also:
    
    AbstractGroup#insertRepetition(Structure, int)
  - insertLCH
```
public LCH insertLCH(int rep)
              throws HL7Exception
```
    Inserts a specific repetition of LCH (Location Characteristic)
    
    Throws:
    
    HL7Exception
    
    See Also:
    
    AbstractGroup#insertRepetition(Structure, int)
  - removeLCH
```
public LCH removeLCH(int rep)
              throws HL7Exception
```
    Removes a specific repetition of LCH (Location Characteristic)
    
    Throws:
    
    HL7Exception
    
    See Also:
    
    AbstractGroup.removeRepetition(String, int)
  - getLRL
```
public LRL getLRL()
```
    Returns the first repetition of LRL (Location Relationship) - creates it if necessary
  - getLRL
```
public LRL getLRL(int rep)
```
    Returns a specific repetition of LRL (Location Relationship) - 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.
  - getLRLReps
```
public int getLRLReps()
```
    Returns the number of existing repetitions of LRL
  - getLRLAll
```
public List<LRL> getLRLAll()
                    throws HL7Exception
```
    Returns a non-modifiable List containing all current existing repetitions of LRL.
    
    Note that unlike getLRL(), this method will not create any reps if none are already present, so an empty list may be returned.
    
    Throws:
    
    HL7Exception
  - insertLRL
```
public void insertLRL(LRL structure,
                      int rep)
               throws HL7Exception
```
    Inserts a specific repetition of LRL (Location Relationship)
    
    Throws:
    
    HL7Exception
    
    See Also:
    
    AbstractGroup#insertRepetition(Structure, int)
  - insertLRL
```
public LRL insertLRL(int rep)
              throws HL7Exception
```
    Inserts a specific repetition of LRL (Location Relationship)
    
    Throws:
    
    HL7Exception
    
    See Also:
    
    AbstractGroup#insertRepetition(Structure, int)
  - removeLRL
```
public LRL removeLRL(int rep)
              throws HL7Exception
```
    Removes a specific repetition of LRL (Location Relationship)
    
    Throws:
    
    HL7Exception
    
    See Also:
    
    AbstractGroup.removeRepetition(String, int)
  - getLDP
```
public LDP getLDP()
```
    Returns the first repetition of LDP (Location Department) - creates it if necessary
  - getLDP
```
public LDP getLDP(int rep)
```
    Returns a specific repetition of LDP (Location Department) - 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.
  - getLDPReps
```
public int getLDPReps()
```
    Returns the number of existing repetitions of LDP
  - getLDPAll
```
public List<LDP> getLDPAll()
                    throws HL7Exception
```
    Returns a non-modifiable List containing all current existing repetitions of LDP.
    
    Note that unlike getLDP(), this method will not create any reps if none are already present, so an empty list may be returned.
    
    Throws:
    
    HL7Exception
  - insertLDP
```
public void insertLDP(LDP structure,
                      int rep)
               throws HL7Exception
```
    Inserts a specific repetition of LDP (Location Department)
    
    Throws:
    
    HL7Exception
    
    See Also:
    
    AbstractGroup#insertRepetition(Structure, int)
  - insertLDP
```
public LDP insertLDP(int rep)
              throws HL7Exception
```
    Inserts a specific repetition of LDP (Location Department)
    
    Throws:
    
    HL7Exception
    
    See Also:
    
    AbstractGroup#insertRepetition(Structure, int)
  - removeLDP
```
public LDP removeLDP(int rep)
              throws HL7Exception
```
    Removes a specific repetition of LDP (Location Department)
    
    Throws:
    
    HL7Exception
    
    See Also:
    
    AbstractGroup.removeRepetition(String, int)
  - getLCH2
```
public LCH getLCH2()
```
    Returns the first repetition of LCH2 (Location Characteristic) - creates it if necessary
  - getLCH2
```
public LCH getLCH2(int rep)
```
    Returns a specific repetition of LCH (Location Characteristic) - 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.
  - getLCH2Reps
```
public int getLCH2Reps()
```
    Returns the number of existing repetitions of LCH2
  - getLCH2All
```
public List<LCH> getLCH2All()
                     throws HL7Exception
```
    Returns a non-modifiable List containing all current existing repetitions of LCH2.
    
    Note that unlike getLCH2(), this method will not create any reps if none are already present, so an empty list may be returned.
    
    Throws:
    
    HL7Exception
  - insertLCH2
```
public void insertLCH2(LCH structure,
                       int rep)
                throws HL7Exception
```
    Inserts a specific repetition of LCH2 (Location Characteristic)
    
    Throws:
    
    HL7Exception
    
    See Also:
    
    AbstractGroup#insertRepetition(Structure, int)
  - insertLCH2
```
public LCH insertLCH2(int rep)
               throws HL7Exception
```
    Inserts a specific repetition of LCH2 (Location Characteristic)
    
    Throws:
    
    HL7Exception
    
    See Also:
    
    AbstractGroup#insertRepetition(Structure, int)
  - removeLCH2
```
public LCH removeLCH2(int rep)
               throws HL7Exception
```
    Removes a specific repetition of LCH2 (Location Characteristic)
    
    Throws:
    
    HL7Exception
    
    See Also:
    
    AbstractGroup.removeRepetition(String, int)
  - getLCC
```
public LCC getLCC()
```
    Returns the first repetition of LCC (Location Charge Code) - creates it if necessary
  - getLCC
```
public LCC getLCC(int rep)
```
    Returns a specific repetition of LCC (Location Charge Code) - 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.
  - getLCCReps
```
public int getLCCReps()
```
    Returns the number of existing repetitions of LCC
  - getLCCAll
```
public List<LCC> getLCCAll()
                    throws HL7Exception
```
    Returns a non-modifiable List containing all current existing repetitions of LCC.
    
    Note that unlike getLCC(), this method will not create any reps if none are already present, so an empty list may be returned.
    
    Throws:
    
    HL7Exception
  - insertLCC
```
public void insertLCC(LCC structure,
                      int rep)
               throws HL7Exception
```
    Inserts a specific repetition of LCC (Location Charge Code)
    
    Throws:
    
    HL7Exception
    
    See Also:
    
    AbstractGroup#insertRepetition(Structure, int)
  - insertLCC
```
public LCC insertLCC(int rep)
              throws HL7Exception
```
    Inserts a specific repetition of LCC (Location Charge Code)
    
    Throws:
    
    HL7Exception
    
    See Also:
    
    AbstractGroup#insertRepetition(Structure, int)
  - removeLCC
```
public LCC removeLCC(int rep)
              throws HL7Exception
```
    Removes a specific repetition of LCC (Location Charge Code)
    
    Throws:
    
    HL7Exception
    
    See Also:
    
    AbstractGroup.removeRepetition(String, int)

Class MFR_M05_MF_QUERY

Field Summary

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

Constructor Summary

Method Summary

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

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

Methods inherited from class java.lang.Object

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

Constructor Detail

MFR_M05_MF_QUERY

Method Detail

getVersion

getMFE

getLOC

getLCH

getLCH

getLCHReps

getLCHAll

insertLCH

insertLCH

removeLCH

getLRL

getLRL

getLRLReps

getLRLAll

insertLRL

insertLRL

removeLRL

getLDP

getLDP

getLDPReps

getLDPAll

insertLDP

insertLDP

removeLDP

getLCH2

getLCH2

getLCH2Reps

getLCH2All

insertLCH2

insertLCH2

removeLCH2

getLCC

getLCC

getLCCReps

getLCCAll

insertLCC

insertLCC

removeLCC