ca.uhn.hl7v2.model.v231.message

Class MFK_M05

java.lang.Object

ca.uhn.hl7v2.model.AbstractStructure

ca.uhn.hl7v2.model.AbstractGroup

ca.uhn.hl7v2.model.AbstractMessage

ca.uhn.hl7v2.model.v231.message.MFK_M05

All Implemented Interfaces:

Group, Message, Structure, Visitable, Serializable

public class MFK_M05
extends AbstractMessage

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

• 1: MSH (MSH - message header segment)
• 2: MSA (MSA - message acknowledgment segment)
• 3: MFI (MFI - master file identification segment)
• 4: MFA (MFA - master file acknowledgment segment) optional repeating

See Also:

Serialized Form

Field Summary

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

log

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
MFA	getMFA() Returns the first repetition of MFA (MFA - master file acknowledgment segment) - creates it if necessary
MFA	getMFA(int rep) Returns a specific repetition of MFA (MFA - master file acknowledgment segment) - 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 (MFI - master file identification segment) - creates it if necessary
MSA	getMSA() Returns MSA (MSA - message acknowledgment segment) - creates it if necessary
MSH	getMSH() Returns MSH (MSH - message header segment) - creates it if necessary
String	getVersion() Returns "2.3.1"
MFA	insertMFA(int rep) Inserts a specific repetition of MFA (MFA - master file acknowledgment segment)
void	insertMFA(MFA structure, int rep) Inserts a specific repetition of MFA (MFA - master file acknowledgment segment)
MFA	removeMFA(int rep) Removes a specific repetition of MFA (MFA - master file acknowledgment 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

MFK_M05

public MFK_M05()

Creates a new MFK_M05 message with DefaultModelClassFactory.

MFK_M05

public MFK_M05(ModelClassFactory factory)

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

getMSA

public MSA getMSA()

Returns MSA (MSA - message acknowledgment segment) - creates it if necessary

getMFI

public MFI getMFI()

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

getMFA

public MFA getMFA()

Returns the first repetition of MFA (MFA - master file acknowledgment segment) - creates it if necessary

getMFA

public MFA getMFA(int rep)

Returns a specific repetition of MFA (MFA - master file acknowledgment 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.

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 (MFA - master file acknowledgment segment)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

insertMFA

public MFA insertMFA(int rep)
              throws HL7Exception

Inserts a specific repetition of MFA (MFA - master file acknowledgment segment)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

removeMFA

public MFA removeMFA(int rep)
              throws HL7Exception

Removes a specific repetition of MFA (MFA - master file acknowledgment segment)

Throws:

HL7Exception

See Also:

AbstractGroup.removeRepetition(String, int)