ca.uhn.hl7v2.model.v24.message
Class MFR_M01

java.lang.Object
  ca.uhn.hl7v2.model.AbstractGroup
      ca.uhn.hl7v2.model.AbstractMessage
          ca.uhn.hl7v2.model.v24.message.MFR_M01

All Implemented Interfaces:

Group, Message, Structure, Serializable

public class MFR_M01
extends AbstractMessage

Represents a MFR_M01 message structure (see chapter 8). This structure contains the following elements:

• 1: MSH (Message Header)
• 2: MSA (Message Acknowledgment)
• 3: ERR (Error) optional
• 4: QAK (Query Acknowledgment) optional
• 5: QRD (Original-Style Query Definition)
• 6: QRF (Original Style Query Filter) optional
• 7: MFI (Master File Identification)
• 8: MFR_M01_MF_QUERY (a Group object) repeating
• 9: DSC (Continuation Pointer) optional

See Also:

Serialized Form

Constructor Summary

MFR_M01()
Creates a new MFR_M01 message with DefaultModelClassFactory.

MFR_M01(ModelClassFactory factory)
Creates a new MFR_M01 message with custom ModelClassFactory.

Method Summary

DSC	getDSC() Returns DSC (Continuation Pointer) - creates it if necessary
ERR	getERR() Returns ERR (Error) - creates it if necessary
MFR_M01_MF_QUERY	getMF_QUERY() Returns the first repetition of MF_QUERY (a Group object) - creates it if necessary
MFR_M01_MF_QUERY	getMF_QUERY(int rep) Returns a specific repetition of MF_QUERY (a Group object) - creates it if necessary
int	getMF_QUERYReps() Returns the number of existing repetitions of MF_QUERY
MFI	getMFI() Returns MFI (Master File Identification) - creates it if necessary
MSA	getMSA() Returns MSA (Message Acknowledgment) - creates it if necessary
MSH	getMSH() Returns MSH (Message Header) - creates it if necessary
QAK	getQAK() Returns QAK (Query Acknowledgment) - creates it if necessary
QRD	getQRD() Returns QRD (Original-Style Query Definition) - creates it if necessary
QRF	getQRF() Returns QRF (Original Style Query Filter) - creates it if necessary
String	getVersion() Returns "2.4"
MFR_M01_MF_QUERY	insertMF_QUERY(int rep) Inserts a specific repetition of MF_QUERY (a Group object)
void	insertMF_QUERY(MFR_M01_MF_QUERY structure, int rep) Inserts a specific repetition of MF_QUERY (a Group object)
MFR_M01_MF_QUERY	removeMF_QUERY(int rep) Removes a specific repetition of MF_QUERY (a Group object)

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

encode, generateACK, generateACK, getEncodingCharactersValue, getFieldSeparatorValue, getMessage, 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, getClass, getModelClassFactory, getName, getNames, getParent, insertRepetition, insertRepetition, isGroup, isRepeating, isRequired, removeRepetition

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, getParent

Constructor Detail

MFR_M01

public MFR_M01()

Creates a new MFR_M01 message with DefaultModelClassFactory.

MFR_M01

public MFR_M01(ModelClassFactory factory)

Creates a new MFR_M01 message with custom ModelClassFactory.

Method Detail

getVersion

public String getVersion()

Returns "2.4"

Specified by:

getVersion in interface Message

Overrides:

getVersion in class AbstractMessage

getMSH

public MSH getMSH()

Returns MSH (Message Header) - creates it if necessary

getMSA

public MSA getMSA()

Returns MSA (Message Acknowledgment) - creates it if necessary

getERR

public ERR getERR()

Returns ERR (Error) - creates it if necessary

getQAK

public QAK getQAK()

Returns QAK (Query Acknowledgment) - creates it if necessary

getQRD

public QRD getQRD()

Returns QRD (Original-Style Query Definition) - creates it if necessary

getQRF

public QRF getQRF()

Returns QRF (Original Style Query Filter) - creates it if necessary

getMFI

public MFI getMFI()

Returns MFI (Master File Identification) - creates it if necessary

getMF_QUERY

public MFR_M01_MF_QUERY getMF_QUERY()

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

getMF_QUERY

public MFR_M01_MF_QUERY getMF_QUERY(int rep)

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

getMF_QUERYReps

public int getMF_QUERYReps()

Returns the number of existing repetitions of MF_QUERY

insertMF_QUERY

public void insertMF_QUERY(MFR_M01_MF_QUERY structure,
                           int rep)
                    throws HL7Exception

Inserts a specific repetition of MF_QUERY (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup\#insertRepetition(Structure, int)

insertMF_QUERY

public MFR_M01_MF_QUERY insertMF_QUERY(int rep)
                                throws HL7Exception

Inserts a specific repetition of MF_QUERY (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup\#insertRepetition(Structure, int)

removeMF_QUERY

public MFR_M01_MF_QUERY removeMF_QUERY(int rep)
                                throws HL7Exception

Removes a specific repetition of MF_QUERY (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup\#removeRepetition(String, int)

getDSC

public DSC getDSC()

Returns DSC (Continuation Pointer) - creates it if necessary