ca.uhn.hl7v2.model.v251.message

Class MFN_M04

java.lang.Object

ca.uhn.hl7v2.model.AbstractStructure

ca.uhn.hl7v2.model.AbstractGroup

ca.uhn.hl7v2.model.AbstractMessage

ca.uhn.hl7v2.model.v251.message.MFN_M04

All Implemented Interfaces:

Group, Message, Structure, Visitable, Serializable

public class MFN_M04
extends AbstractMessage

Represents a MFN_M04 message structure (see chapter 8.10.1). This structure contains the following elements:

• 1: MSH (Message Header)
• 2: SFT (Software Segment) optional repeating
• 3: MFI (Master File Identification)
• 4: MFN_M04_MF_CDM (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_M04() Creates a new MFN_M04 message with DefaultModelClassFactory.
MFN_M04(ModelClassFactory factory) Creates a new MFN_M04 message with custom ModelClassFactory.

Method Summary

Modifier and Type	Method and Description
MFN_M04_MF_CDM	getMF_CDM() Returns the first repetition of MF_CDM (a Group object) - creates it if necessary
MFN_M04_MF_CDM	getMF_CDM(int rep) Returns a specific repetition of MF_CDM (a Group object) - creates it if necessary
List<MFN_M04_MF_CDM>	getMF_CDMAll() Returns a non-modifiable List containing all current existing repetitions of MF_CDM.
int	getMF_CDMReps() Returns the number of existing repetitions of MF_CDM
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
String	getVersion() Returns "2.5.1"
MFN_M04_MF_CDM	insertMF_CDM(int rep) Inserts a specific repetition of MF_CDM (a Group object)
void	insertMF_CDM(MFN_M04_MF_CDM structure, int rep) Inserts a specific repetition of MF_CDM (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_M04_MF_CDM	removeMF_CDM(int rep) Removes a specific repetition of MF_CDM (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_M04

public MFN_M04()

Creates a new MFN_M04 message with DefaultModelClassFactory.

MFN_M04

public MFN_M04(ModelClassFactory factory)

Creates a new MFN_M04 message with custom ModelClassFactory.

Method Detail

getVersion

public String getVersion()

Returns "2.5.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)

getMFI

public MFI getMFI()

Returns MFI (Master File Identification) - creates it if necessary

getMF_CDM

public MFN_M04_MF_CDM getMF_CDM()

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

getMF_CDM

public MFN_M04_MF_CDM getMF_CDM(int rep)

Returns a specific repetition of MF_CDM (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_CDMReps

public int getMF_CDMReps()

Returns the number of existing repetitions of MF_CDM

getMF_CDMAll

public List<MFN_M04_MF_CDM> getMF_CDMAll()
                                  throws HL7Exception

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

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

Throws:

HL7Exception

insertMF_CDM

public void insertMF_CDM(MFN_M04_MF_CDM structure,
                         int rep)
                  throws HL7Exception

Inserts a specific repetition of MF_CDM (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

insertMF_CDM

public MFN_M04_MF_CDM insertMF_CDM(int rep)
                            throws HL7Exception

Inserts a specific repetition of MF_CDM (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

removeMF_CDM

public MFN_M04_MF_CDM removeMF_CDM(int rep)
                            throws HL7Exception

Removes a specific repetition of MF_CDM (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup.removeRepetition(String, int)