Package ca.uhn.hl7v2.model.v22.message

Class MFD_M02

java.lang.Object

ca.uhn.hl7v2.model.AbstractStructure

ca.uhn.hl7v2.model.AbstractGroup

ca.uhn.hl7v2.model.AbstractMessage

ca.uhn.hl7v2.model.v22.message.MFD_M02

All Implemented Interfaces:

Group, Message, Structure, Visitable, Serializable

public class MFD_M02
extends AbstractMessage

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

• 1: MSH (MESSAGE HEADER)
• 2: MFI (MASTER FILE IDENTIFICATION)
• 3: MFA (MASTER FILE ACKNOWLEDGEMENT) optional repeating

See Also:

• Serialized Form

Field Summary

Fields inherited from class ca.uhn.hl7v2.model.AbstractStructure

log

Constructor Summary

Constructors

Constructor	Description
MFD_M02()	Creates a new MFD_M02 message with DefaultModelClassFactory.
MFD_M02(ModelClassFactory factory)	Creates a new MFD_M02 message with custom ModelClassFactory.

Method Summary

Modifier and Type	Method	Description
MFA	getMFA()	Returns the first repetition of MFA (MASTER FILE ACKNOWLEDGEMENT) - creates it if necessary
MFA	getMFA(int rep)	Returns a specific repetition of MFA (MASTER FILE ACKNOWLEDGEMENT) - creates it if necessary
List<MFA>	getMFAAll()	Returns a non-modifiable List containing all current existing repetitions of MFA.
int	getMFAReps()	Returns the number of existing repetitions of MFA
MFI	getMFI()	Returns MFI (MASTER FILE IDENTIFICATION) - creates it if necessary
MSH	getMSH()	Returns MSH (MESSAGE HEADER) - creates it if necessary
String	getVersion()	Returns "2.2"
MFA	insertMFA(int rep)	Inserts a specific repetition of MFA (MASTER FILE ACKNOWLEDGEMENT)
void	insertMFA(MFA structure, int rep)	Inserts a specific repetition of MFA (MASTER FILE ACKNOWLEDGEMENT)
MFA	removeMFA(int rep)	Removes a specific repetition of MFA (MASTER FILE ACKNOWLEDGEMENT)

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

accept, copy, 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 Details

MFD_M02

public MFD_M02()

Creates a new MFD_M02 message with DefaultModelClassFactory.

MFD_M02

public MFD_M02(ModelClassFactory factory)

Creates a new MFD_M02 message with custom ModelClassFactory.

Method Details

getVersion

public String getVersion()

Returns "2.2"

Specified by:

getVersion in interface Message

Overrides:

getVersion in class AbstractMessage

getMSH

public MSH getMSH()

Returns MSH (MESSAGE HEADER) - creates it if necessary

getMFI

public MFI getMFI()

Returns MFI (MASTER FILE IDENTIFICATION) - creates it if necessary

getMFA

public MFA getMFA()

Returns the first repetition of MFA (MASTER FILE ACKNOWLEDGEMENT) - creates it if necessary

getMFA

public MFA getMFA(int rep)

Returns a specific repetition of MFA (MASTER FILE ACKNOWLEDGEMENT) - 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.

getMFAReps

public int getMFAReps()

Returns the number of existing repetitions of MFA

getMFAAll

public List<MFA> getMFAAll()
                    throws HL7Exception

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

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

Throws:

HL7Exception

insertMFA

public void insertMFA(MFA structure,
 int rep)
               throws HL7Exception

Inserts a specific repetition of MFA (MASTER FILE ACKNOWLEDGEMENT)

Throws:

HL7Exception

See Also:

• AbstractGroup#insertRepetition(Structure, int)

insertMFA

public MFA insertMFA(int rep)
              throws HL7Exception

Inserts a specific repetition of MFA (MASTER FILE ACKNOWLEDGEMENT)

Throws:

HL7Exception

See Also:

• AbstractGroup#insertRepetition(Structure, int)

removeMFA

public MFA removeMFA(int rep)
              throws HL7Exception

Removes a specific repetition of MFA (MASTER FILE ACKNOWLEDGEMENT)

Throws:

HL7Exception

See Also:

• AbstractGroup.removeRepetition(String, int)