Package ca.uhn.hl7v2.model.v24.group

Class MFN_M05_MF_LOCATION

java.lang.Object

ca.uhn.hl7v2.model.AbstractStructure

ca.uhn.hl7v2.model.AbstractGroup

ca.uhn.hl7v2.model.v24.group.MFN_M05_MF_LOCATION

All Implemented Interfaces:

Group, Structure, Visitable, Serializable

public class MFN_M05_MF_LOCATION
extends AbstractGroup

Represents a MFN_M05_MF_LOCATION 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: MFN_M05_MF_LOC_DEPT (a Group object) repeating

See Also:

• Serialized Form

Field Summary

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

log

Constructor Summary

Constructors

Constructor	Description
MFN_M05_MF_LOCATION(Group parent, ModelClassFactory factory)	Creates a new MFN_M05_MF_LOCATION group

Method Summary

Modifier and Type	Method	Description
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
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
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
MFN_M05_MF_LOC_DEPT	getMF_LOC_DEPT()	Returns the first repetition of MF_LOC_DEPT (a Group object) - creates it if necessary
MFN_M05_MF_LOC_DEPT	getMF_LOC_DEPT(int rep)	Returns a specific repetition of MF_LOC_DEPT (a Group object) - creates it if necessary
List<MFN_M05_MF_LOC_DEPT>	getMF_LOC_DEPTAll()	Returns a non-modifiable List containing all current existing repetitions of MF_LOC_DEPT.
int	getMF_LOC_DEPTReps()	Returns the number of existing repetitions of MF_LOC_DEPT
MFE	getMFE()	Returns MFE (Master File Entry) - creates it if necessary
String	getVersion()	Returns "2.4"
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)
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)
MFN_M05_MF_LOC_DEPT	insertMF_LOC_DEPT(int rep)	Inserts a specific repetition of MF_LOC_DEPT (a Group object)
void	insertMF_LOC_DEPT(MFN_M05_MF_LOC_DEPT structure, int rep)	Inserts a specific repetition of MF_LOC_DEPT (a Group object)
LCH	removeLCH(int rep)	Removes a specific repetition of LCH (Location Characteristic)
LRL	removeLRL(int rep)	Removes a specific repetition of LRL (Location Relationship)
MFN_M05_MF_LOC_DEPT	removeMF_LOC_DEPT(int rep)	Removes a specific repetition of MF_LOC_DEPT (a Group object)

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 Details

MFN_M05_MF_LOCATION

public MFN_M05_MF_LOCATION(Group parent,
 ModelClassFactory factory)

Creates a new MFN_M05_MF_LOCATION group

Method Details

getVersion

public String getVersion()

Returns "2.4"

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)

getMF_LOC_DEPT

public MFN_M05_MF_LOC_DEPT getMF_LOC_DEPT()

Returns the first repetition of MF_LOC_DEPT (a Group object) - creates it if necessary

getMF_LOC_DEPT

public MFN_M05_MF_LOC_DEPT getMF_LOC_DEPT(int rep)

Returns a specific repetition of MF_LOC_DEPT (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_LOC_DEPTReps

public int getMF_LOC_DEPTReps()

Returns the number of existing repetitions of MF_LOC_DEPT

getMF_LOC_DEPTAll

public List<MFN_M05_MF_LOC_DEPT> getMF_LOC_DEPTAll()
                                            throws HL7Exception

Returns a non-modifiable List containing all current existing repetitions of MF_LOC_DEPT.

Note that unlike getMF_LOC_DEPT(), this method will not create any reps if none are already present, so an empty list may be returned.

Throws:

HL7Exception

insertMF_LOC_DEPT

public void insertMF_LOC_DEPT(MFN_M05_MF_LOC_DEPT structure,
 int rep)
                       throws HL7Exception

Inserts a specific repetition of MF_LOC_DEPT (a Group object)

Throws:

HL7Exception

See Also:

• AbstractGroup#insertRepetition(Structure, int)

insertMF_LOC_DEPT

public MFN_M05_MF_LOC_DEPT insertMF_LOC_DEPT(int rep)
                                      throws HL7Exception

Inserts a specific repetition of MF_LOC_DEPT (a Group object)

Throws:

HL7Exception

See Also:

• AbstractGroup#insertRepetition(Structure, int)

removeMF_LOC_DEPT

public MFN_M05_MF_LOC_DEPT removeMF_LOC_DEPT(int rep)
                                      throws HL7Exception

Removes a specific repetition of MF_LOC_DEPT (a Group object)

Throws:

HL7Exception

See Also:

• AbstractGroup.removeRepetition(String, int)