ca.uhn.hl7v2.model.v23.message

Class MFK_M01

java.lang.Object

ca.uhn.hl7v2.model.AbstractStructure

ca.uhn.hl7v2.model.AbstractGroup

ca.uhn.hl7v2.model.AbstractMessage

ca.uhn.hl7v2.model.v23.message.MFK_M01

All Implemented Interfaces:

Group, Message, Structure, Serializable

public class MFK_M01
extends AbstractMessage

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

• 1: MSH (Message header segment)
• 2: MSA (Message acknowledgement segment)
• 3: MFI (Master file identification segment)
• 4: ERR (Error segment) optional
• 5: MFA (Master file acknowledgement segment) optional repeating
• 6: MFI (Master file identification segment)
• 7: MFK_M01_MF (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
MFK_M01() Creates a new MFK_M01 message with DefaultModelClassFactory.
MFK_M01(ModelClassFactory factory) Creates a new MFK_M01 message with custom ModelClassFactory.

Method Summary

Methods

Modifier and Type	Method and Description
ERR	getERR() Returns ERR (Error segment) - creates it if necessary
MFK_M01_MF	getMF() Returns the first repetition of MF (a Group object) - creates it if necessary
MFK_M01_MF	getMF(int rep) Returns a specific repetition of MF (a Group object) - creates it if necessary
MFA	getMFA() Returns the first repetition of MFA (Master file acknowledgement segment) - creates it if necessary
MFA	getMFA(int rep) Returns a specific repetition of MFA (Master file acknowledgement segment) - creates it if necessary
List<MFA>	getMFAAll() Returns a non-modifiable List containing all current existing repetitions of MFA.
List<MFK_M01_MF>	getMFAll() Returns a non-modifiable List containing all current existing repetitions of MF.
int	getMFAReps() Returns the number of existing repetitions of MFA
MFI	getMFI() Returns MFI (Master file identification segment) - creates it if necessary
MFI	getMFI2() Returns MFI2 (Master file identification segment) - creates it if necessary
int	getMFReps() Returns the number of existing repetitions of MF
MSA	getMSA() Returns MSA (Message acknowledgement segment) - creates it if necessary
MSH	getMSH() Returns MSH (Message header segment) - creates it if necessary
String	getVersion() Returns "2.3"
MFK_M01_MF	insertMF(int rep) Inserts a specific repetition of MF (a Group object)
void	insertMF(MFK_M01_MF structure, int rep) Inserts a specific repetition of MF (a Group object)
MFA	insertMFA(int rep) Inserts a specific repetition of MFA (Master file acknowledgement segment)
void	insertMFA(MFA structure, int rep) Inserts a specific repetition of MFA (Master file acknowledgement segment)
MFK_M01_MF	removeMF(int rep) Removes a specific repetition of MF (a Group object)
MFA	removeMFA(int rep) Removes a specific repetition of MFA (Master file acknowledgement segment)

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

MFK_M01

public MFK_M01()

Creates a new MFK_M01 message with DefaultModelClassFactory.

MFK_M01

public MFK_M01(ModelClassFactory factory)

Creates a new MFK_M01 message with custom ModelClassFactory.

Method Detail

getVersion

public String getVersion()

Returns "2.3"

Specified by:

getVersion in interface Message

Overrides:

getVersion in class AbstractMessage

getMSH

public MSH getMSH()

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

getMSA

public MSA getMSA()

Returns MSA (Message acknowledgement segment) - creates it if necessary

getMFI

public MFI getMFI()

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

getERR

public ERR getERR()

Returns ERR (Error segment) - creates it if necessary

getMFA

public MFA getMFA()

Returns the first repetition of MFA (Master file acknowledgement segment) - creates it if necessary

getMFA

public MFA getMFA(int rep)

Returns a specific repetition of MFA (Master file acknowledgement 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 (Master file acknowledgement segment)

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 segment)

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 segment)

Throws:

HL7Exception

See Also:

AbstractGroup#removeRepetition(String, int)

getMFI2

public MFI getMFI2()

Returns MFI2 (Master file identification segment) - creates it if necessary

getMF

public MFK_M01_MF getMF()

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

getMF

public MFK_M01_MF getMF(int rep)

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

getMFReps

public int getMFReps()

Returns the number of existing repetitions of MF

getMFAll

public List<MFK_M01_MF> getMFAll()
                          throws HL7Exception

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

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

Throws:

HL7Exception

insertMF

public void insertMF(MFK_M01_MF structure,
            int rep)
              throws HL7Exception

Inserts a specific repetition of MF (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

insertMF

public MFK_M01_MF insertMF(int rep)
                    throws HL7Exception

Inserts a specific repetition of MF (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

removeMF

public MFK_M01_MF removeMF(int rep)
                    throws HL7Exception

Removes a specific repetition of MF (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup#removeRepetition(String, int)