ca.uhn.hl7v2.model.v231.message

Class MFN_M02

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_M02

All Implemented Interfaces:

Group, Message, Structure, Serializable

public class MFN_M02
extends AbstractMessage

Represents a MFN_M02 message structure (see chapter ${chapter}). This structure contains the following elements:

• 1: MSH (MSH - message header segment)
• 2: MFI (MFI - master file identification segment)
• 3: MFN_M02_MFESTFPRA (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_M02() Creates a new MFN_M02 message with DefaultModelClassFactory.
MFN_M02(ModelClassFactory factory) Creates a new MFN_M02 message with custom ModelClassFactory.

Method Summary

Methods

Modifier and Type	Method and Description
MFN_M02_MFESTFPRA	getMFESTFPRA() Returns the first repetition of MFESTFPRA (a Group object) - creates it if necessary
MFN_M02_MFESTFPRA	getMFESTFPRA(int rep) Returns a specific repetition of MFESTFPRA (a Group object) - creates it if necessary
List<MFN_M02_MFESTFPRA>	getMFESTFPRAAll() Returns a non-modifiable List containing all current existing repetitions of MFESTFPRA.
int	getMFESTFPRAReps() Returns the number of existing repetitions of MFESTFPRA
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_M02_MFESTFPRA	insertMFESTFPRA(int rep) Inserts a specific repetition of MFESTFPRA (a Group object)
void	insertMFESTFPRA(MFN_M02_MFESTFPRA structure, int rep) Inserts a specific repetition of MFESTFPRA (a Group object)
MFN_M02_MFESTFPRA	removeMFESTFPRA(int rep) Removes a specific repetition of MFESTFPRA (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_M02

public MFN_M02()

Creates a new MFN_M02 message with DefaultModelClassFactory.

MFN_M02

public MFN_M02(ModelClassFactory factory)

Creates a new MFN_M02 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

getMFESTFPRA

public MFN_M02_MFESTFPRA getMFESTFPRA()

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

getMFESTFPRA

public MFN_M02_MFESTFPRA getMFESTFPRA(int rep)

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

getMFESTFPRAReps

public int getMFESTFPRAReps()

Returns the number of existing repetitions of MFESTFPRA

getMFESTFPRAAll

public List<MFN_M02_MFESTFPRA> getMFESTFPRAAll()
                                        throws HL7Exception

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

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

Throws:

HL7Exception

insertMFESTFPRA

public void insertMFESTFPRA(MFN_M02_MFESTFPRA structure,
                   int rep)
                     throws HL7Exception

Inserts a specific repetition of MFESTFPRA (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

insertMFESTFPRA

public MFN_M02_MFESTFPRA insertMFESTFPRA(int rep)
                                  throws HL7Exception

Inserts a specific repetition of MFESTFPRA (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

removeMFESTFPRA

public MFN_M02_MFESTFPRA removeMFESTFPRA(int rep)
                                  throws HL7Exception

Removes a specific repetition of MFESTFPRA (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup#removeRepetition(String, int)