ca.uhn.hl7v2.model.v231.message

Class MFN_M03

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_M03

All Implemented Interfaces:

Group, Message, Structure, Serializable

public class MFN_M03
extends AbstractMessage

Represents a MFN_M03 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_M03_MFEOM1Hxx (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_M03() Creates a new MFN_M03 message with DefaultModelClassFactory.
MFN_M03(ModelClassFactory factory) Creates a new MFN_M03 message with custom ModelClassFactory.

Method Summary

Methods

Modifier and Type	Method and Description
MFN_M03_MFEOM1Hxx	getMFEOM1Hxx() Returns the first repetition of MFEOM1Hxx (a Group object) - creates it if necessary
MFN_M03_MFEOM1Hxx	getMFEOM1Hxx(int rep) Returns a specific repetition of MFEOM1Hxx (a Group object) - creates it if necessary
List<MFN_M03_MFEOM1Hxx>	getMFEOM1HxxAll() Returns a non-modifiable List containing all current existing repetitions of MFEOM1Hxx.
int	getMFEOM1HxxReps() Returns the number of existing repetitions of MFEOM1Hxx
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_M03_MFEOM1Hxx	insertMFEOM1Hxx(int rep) Inserts a specific repetition of MFEOM1Hxx (a Group object)
void	insertMFEOM1Hxx(MFN_M03_MFEOM1Hxx structure, int rep) Inserts a specific repetition of MFEOM1Hxx (a Group object)
MFN_M03_MFEOM1Hxx	removeMFEOM1Hxx(int rep) Removes a specific repetition of MFEOM1Hxx (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_M03

public MFN_M03()

Creates a new MFN_M03 message with DefaultModelClassFactory.

MFN_M03

public MFN_M03(ModelClassFactory factory)

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

getMFEOM1Hxx

public MFN_M03_MFEOM1Hxx getMFEOM1Hxx()

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

getMFEOM1Hxx

public MFN_M03_MFEOM1Hxx getMFEOM1Hxx(int rep)

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

getMFEOM1HxxReps

public int getMFEOM1HxxReps()

Returns the number of existing repetitions of MFEOM1Hxx

getMFEOM1HxxAll

public List<MFN_M03_MFEOM1Hxx> getMFEOM1HxxAll()
                                        throws HL7Exception

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

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

Throws:

HL7Exception

insertMFEOM1Hxx

public void insertMFEOM1Hxx(MFN_M03_MFEOM1Hxx structure,
                   int rep)
                     throws HL7Exception

Inserts a specific repetition of MFEOM1Hxx (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

insertMFEOM1Hxx

public MFN_M03_MFEOM1Hxx insertMFEOM1Hxx(int rep)
                                  throws HL7Exception

Inserts a specific repetition of MFEOM1Hxx (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

removeMFEOM1Hxx

public MFN_M03_MFEOM1Hxx removeMFEOM1Hxx(int rep)
                                  throws HL7Exception

Removes a specific repetition of MFEOM1Hxx (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup#removeRepetition(String, int)