ca.uhn.hl7v2.model.v231.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.v231.message.MFN_M04

All Implemented Interfaces:

Group, Message, Structure, Serializable

public class MFN_M04
extends AbstractMessage

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

• 1: MSH (MSH - message header segment)
• 2: MFI (MFI - master file identification segment)
• 3: MFN_M04_MFECDMPRC (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

Methods

Modifier and Type	Method and Description
MFN_M04_MFECDMPRC	getMFECDMPRC() Returns the first repetition of MFECDMPRC (a Group object) - creates it if necessary
MFN_M04_MFECDMPRC	getMFECDMPRC(int rep) Returns a specific repetition of MFECDMPRC (a Group object) - creates it if necessary
List<MFN_M04_MFECDMPRC>	getMFECDMPRCAll() Returns a non-modifiable List containing all current existing repetitions of MFECDMPRC.
int	getMFECDMPRCReps() Returns the number of existing repetitions of MFECDMPRC
MFI	getMFI() Returns MFI (MFI - master file identification segment) - creates it if necessary
MSH	getMSH() Returns MSH (MSH - message header segment) - creates it if necessary
String	getVersion() Returns "2.3.1"
MFN_M04_MFECDMPRC	insertMFECDMPRC(int rep) Inserts a specific repetition of MFECDMPRC (a Group object)
void	insertMFECDMPRC(MFN_M04_MFECDMPRC structure, int rep) Inserts a specific repetition of MFECDMPRC (a Group object)
MFN_M04_MFECDMPRC	removeMFECDMPRC(int rep) Removes a specific repetition of MFECDMPRC (a Group object)

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

encode, generateACK, generateACK, getEncodingCharactersValue, getFieldSeparatorValue, getMessage, getParent, getParser, getValidationContext, initQuickstart, parse, printStructure, setParser, setValidationContext, toString

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 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, isGroup, isRepeating, isRequired

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

getName

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.3.1"

Specified by:

getVersion in interface Message

Overrides:

getVersion in class AbstractMessage

getMSH

public MSH getMSH()

Returns MSH (MSH - message header segment) - creates it if necessary

getMFI

public MFI getMFI()

Returns MFI (MFI - master file identification segment) - creates it if necessary

getMFECDMPRC

public MFN_M04_MFECDMPRC getMFECDMPRC()

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

getMFECDMPRC

public MFN_M04_MFECDMPRC getMFECDMPRC(int rep)

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

getMFECDMPRCReps

public int getMFECDMPRCReps()

Returns the number of existing repetitions of MFECDMPRC

getMFECDMPRCAll

public List<MFN_M04_MFECDMPRC> getMFECDMPRCAll()
                                        throws HL7Exception

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

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

Throws:

HL7Exception

insertMFECDMPRC

public void insertMFECDMPRC(MFN_M04_MFECDMPRC structure,
                   int rep)
                     throws HL7Exception

Inserts a specific repetition of MFECDMPRC (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

insertMFECDMPRC

public MFN_M04_MFECDMPRC insertMFECDMPRC(int rep)
                                  throws HL7Exception

Inserts a specific repetition of MFECDMPRC (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

removeMFECDMPRC

public MFN_M04_MFECDMPRC removeMFECDMPRC(int rep)
                                  throws HL7Exception

Removes a specific repetition of MFECDMPRC (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup#removeRepetition(String, int)