ca.uhn.hl7v2.model.v231.group

Class MFN_M05_MFELOCLCHLRLLDPLCHLCC

java.lang.Object

ca.uhn.hl7v2.model.AbstractStructure

ca.uhn.hl7v2.model.AbstractGroup

ca.uhn.hl7v2.model.v231.group.MFN_M05_MFELOCLCHLRLLDPLCHLCC

All Implemented Interfaces:

Group, Structure, Serializable

public class MFN_M05_MFELOCLCHLRLLDPLCHLCC
extends AbstractGroup

Represents a MFN_M05_MFELOCLCHLRLLDPLCHLCC 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 (MFE - master file entry segment)
• 2: LOC (LOC - location identification segment)
• 3: LCH (LCH - location characteristic segment) optional repeating
• 4: LRL (LRL - location relationship segment) optional repeating
• 5: MFN_M05_LDPLCHLCC (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_M05_MFELOCLCHLRLLDPLCHLCC(Group parent, ModelClassFactory factory) Creates a new MFN_M05_MFELOCLCHLRLLDPLCHLCC group

Method Summary

Methods

Modifier and Type	Method and Description
LCH	getLCH() Returns the first repetition of LCH (LCH - location characteristic segment) - creates it if necessary
LCH	getLCH(int rep) Returns a specific repetition of LCH (LCH - location characteristic segment) - 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
MFN_M05_LDPLCHLCC	getLDPLCHLCC() Returns the first repetition of LDPLCHLCC (a Group object) - creates it if necessary
MFN_M05_LDPLCHLCC	getLDPLCHLCC(int rep) Returns a specific repetition of LDPLCHLCC (a Group object) - creates it if necessary
List<MFN_M05_LDPLCHLCC>	getLDPLCHLCCAll() Returns a non-modifiable List containing all current existing repetitions of LDPLCHLCC.
int	getLDPLCHLCCReps() Returns the number of existing repetitions of LDPLCHLCC
LOC	getLOC() Returns LOC (LOC - location identification segment) - creates it if necessary
LRL	getLRL() Returns the first repetition of LRL (LRL - location relationship segment) - creates it if necessary
LRL	getLRL(int rep) Returns a specific repetition of LRL (LRL - location relationship segment) - 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 (MFE - master file entry segment) - creates it if necessary
String	getVersion() Returns "2.3.1"
LCH	insertLCH(int rep) Inserts a specific repetition of LCH (LCH - location characteristic segment)
void	insertLCH(LCH structure, int rep) Inserts a specific repetition of LCH (LCH - location characteristic segment)
MFN_M05_LDPLCHLCC	insertLDPLCHLCC(int rep) Inserts a specific repetition of LDPLCHLCC (a Group object)
void	insertLDPLCHLCC(MFN_M05_LDPLCHLCC structure, int rep) Inserts a specific repetition of LDPLCHLCC (a Group object)
LRL	insertLRL(int rep) Inserts a specific repetition of LRL (LRL - location relationship segment)
void	insertLRL(LRL structure, int rep) Inserts a specific repetition of LRL (LRL - location relationship segment)
LCH	removeLCH(int rep) Removes a specific repetition of LCH (LCH - location characteristic segment)
MFN_M05_LDPLCHLCC	removeLDPLCHLCC(int rep) Removes a specific repetition of LDPLCHLCC (a Group object)
LRL	removeLRL(int rep) Removes a specific repetition of LRL (LRL - location relationship segment)

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

add, add, addNonstandardSegment, addNonstandardSegment, clear, currentReps, get, get, getAll, getAllAsList, getClass, getFieldNumForName, getModelClassFactory, getName, getNames, getNonStandardNames, getReps, getTyped, getTyped, insert, insertRepetition, insertRepetition, isGroup, isRepeating, isRequired, removeRepetition, tryToInstantiateStructure

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

MFN_M05_MFELOCLCHLRLLDPLCHLCC

public MFN_M05_MFELOCLCHLRLLDPLCHLCC(Group parent,
                             ModelClassFactory factory)

Creates a new MFN_M05_MFELOCLCHLRLLDPLCHLCC group

Method Detail

getVersion

public String getVersion()

Returns "2.3.1"

getMFE

public MFE getMFE()

Returns MFE (MFE - master file entry segment) - creates it if necessary

getLOC

public LOC getLOC()

Returns LOC (LOC - location identification segment) - creates it if necessary

getLCH

public LCH getLCH()

Returns the first repetition of LCH (LCH - location characteristic segment) - creates it if necessary

getLCH

public LCH getLCH(int rep)

Returns a specific repetition of LCH (LCH - location characteristic 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.

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 (LCH - location characteristic segment)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

insertLCH

public LCH insertLCH(int rep)
              throws HL7Exception

Inserts a specific repetition of LCH (LCH - location characteristic segment)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

removeLCH

public LCH removeLCH(int rep)
              throws HL7Exception

Removes a specific repetition of LCH (LCH - location characteristic segment)

Throws:

HL7Exception

See Also:

AbstractGroup.removeRepetition(String, int)

getLRL

public LRL getLRL()

Returns the first repetition of LRL (LRL - location relationship segment) - creates it if necessary

getLRL

public LRL getLRL(int rep)

Returns a specific repetition of LRL (LRL - location relationship 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.

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 (LRL - location relationship segment)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

insertLRL

public LRL insertLRL(int rep)
              throws HL7Exception

Inserts a specific repetition of LRL (LRL - location relationship segment)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

removeLRL

public LRL removeLRL(int rep)
              throws HL7Exception

Removes a specific repetition of LRL (LRL - location relationship segment)

Throws:

HL7Exception

See Also:

AbstractGroup.removeRepetition(String, int)

getLDPLCHLCC

public MFN_M05_LDPLCHLCC getLDPLCHLCC()

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

getLDPLCHLCC

public MFN_M05_LDPLCHLCC getLDPLCHLCC(int rep)

Returns a specific repetition of LDPLCHLCC (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.

getLDPLCHLCCReps

public int getLDPLCHLCCReps()

Returns the number of existing repetitions of LDPLCHLCC

getLDPLCHLCCAll

public List<MFN_M05_LDPLCHLCC> getLDPLCHLCCAll()
                                        throws HL7Exception

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

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

Throws:

HL7Exception

insertLDPLCHLCC

public void insertLDPLCHLCC(MFN_M05_LDPLCHLCC structure,
                   int rep)
                     throws HL7Exception

Inserts a specific repetition of LDPLCHLCC (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

insertLDPLCHLCC

public MFN_M05_LDPLCHLCC insertLDPLCHLCC(int rep)
                                  throws HL7Exception

Inserts a specific repetition of LDPLCHLCC (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

removeLDPLCHLCC

public MFN_M05_LDPLCHLCC removeLDPLCHLCC(int rep)
                                  throws HL7Exception

Removes a specific repetition of LDPLCHLCC (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup.removeRepetition(String, int)