ca.uhn.hl7v2.model.v23.group

Class MFN_M05_MF_LOC_DEPT

java.lang.Object

ca.uhn.hl7v2.model.AbstractStructure

ca.uhn.hl7v2.model.AbstractGroup

ca.uhn.hl7v2.model.v23.group.MFN_M05_MF_LOC_DEPT

All Implemented Interfaces:

Group, Structure, Serializable

public class MFN_M05_MF_LOC_DEPT
extends AbstractGroup

Represents a MFN_M05_MF_LOC_DEPT 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: LDP (Location Department)
• 2: LCH (Location Characteristic) optional repeating
• 3: 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
MFN_M05_MF_LOC_DEPT(Group parent, ModelClassFactory factory) Creates a new MFN_M05_MF_LOC_DEPT group

Method Summary

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
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 LDP (Location Department) - creates it if necessary
String	getVersion() Returns "2.3"
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)
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)

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_MF_LOC_DEPT

public MFN_M05_MF_LOC_DEPT(Group parent,
                   ModelClassFactory factory)

Creates a new MFN_M05_MF_LOC_DEPT group

Method Detail

getVersion

public String getVersion()

Returns "2.3"

getLDP

public LDP getLDP()

Returns LDP (Location Department) - 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)

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)