ca.uhn.hl7v2.model.v25.message

Class MFR_M05

java.lang.Object

ca.uhn.hl7v2.model.AbstractStructure

ca.uhn.hl7v2.model.AbstractGroup

ca.uhn.hl7v2.model.AbstractMessage

ca.uhn.hl7v2.model.v25.message.MFR_M05

All Implemented Interfaces:

Group, Message, Structure, Serializable

public class MFR_M05
extends AbstractMessage

Represents a MFR_M05 message structure (see chapter 8.9.1). This structure contains the following elements:

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

See Also:

Serialized Form

Field Summary

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

log

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
DSC	getDSC() Returns DSC (Continuation Pointer) - creates it if necessary
ERR	getERR() Returns the first repetition of ERR (Error) - creates it if necessary
ERR	getERR(int rep) Returns a specific repetition of ERR (Error) - creates it if necessary
List<ERR>	getERRAll() Returns a non-modifiable List containing all current existing repetitions of ERR.
int	getERRReps() Returns the number of existing repetitions of ERR
MFR_M05_MF_QUERY	getMF_QUERY() Returns the first repetition of MF_QUERY (a Group object) - creates it if necessary
MFR_M05_MF_QUERY	getMF_QUERY(int rep) Returns a specific repetition of MF_QUERY (a Group object) - creates it if necessary
List<MFR_M05_MF_QUERY>	getMF_QUERYAll() Returns a non-modifiable List containing all current existing repetitions of MF_QUERY.
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
SFT	getSFT() Returns the first repetition of SFT (Software Segment) - creates it if necessary
SFT	getSFT(int rep) Returns a specific repetition of SFT (Software Segment) - creates it if necessary
List<SFT>	getSFTAll() Returns a non-modifiable List containing all current existing repetitions of SFT.
int	getSFTReps() Returns the number of existing repetitions of SFT
String	getVersion() Returns "2.5"
void	insertERR(ERR structure, int rep) Inserts a specific repetition of ERR (Error)
ERR	insertERR(int rep) Inserts a specific repetition of ERR (Error)
MFR_M05_MF_QUERY	insertMF_QUERY(int rep) Inserts a specific repetition of MF_QUERY (a Group object)
void	insertMF_QUERY(MFR_M05_MF_QUERY structure, int rep) Inserts a specific repetition of MF_QUERY (a Group object)
SFT	insertSFT(int rep) Inserts a specific repetition of SFT (Software Segment)
void	insertSFT(SFT structure, int rep) Inserts a specific repetition of SFT (Software Segment)
ERR	removeERR(int rep) Removes a specific repetition of ERR (Error)
MFR_M05_MF_QUERY	removeMF_QUERY(int rep) Removes a specific repetition of MF_QUERY (a Group object)
SFT	removeSFT(int rep) Removes a specific repetition of SFT (Software 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

MFR_M05

public MFR_M05()

Creates a new MFR_M05 message with DefaultModelClassFactory.

MFR_M05

public MFR_M05(ModelClassFactory factory)

Creates a new MFR_M05 message with custom ModelClassFactory.

Method Detail

getVersion

public String getVersion()

Returns "2.5"

Specified by:

getVersion in interface Message

Overrides:

getVersion in class AbstractMessage

getMSH

public MSH getMSH()

Returns MSH (Message Header) - creates it if necessary

getSFT

public SFT getSFT()

Returns the first repetition of SFT (Software Segment) - creates it if necessary

getSFT

public SFT getSFT(int rep)

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

getSFTReps

public int getSFTReps()

Returns the number of existing repetitions of SFT

getSFTAll

public List<SFT> getSFTAll()
                    throws HL7Exception

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

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

Throws:

HL7Exception

insertSFT

public void insertSFT(SFT structure,
             int rep)
               throws HL7Exception

Inserts a specific repetition of SFT (Software Segment)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

insertSFT

public SFT insertSFT(int rep)
              throws HL7Exception

Inserts a specific repetition of SFT (Software Segment)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

removeSFT

public SFT removeSFT(int rep)
              throws HL7Exception

Removes a specific repetition of SFT (Software Segment)

Throws:

HL7Exception

See Also:

AbstractGroup#removeRepetition(String, int)

getMSA

public MSA getMSA()

Returns MSA (Message Acknowledgment) - creates it if necessary

getERR

public ERR getERR()

Returns the first repetition of ERR (Error) - creates it if necessary

getERR

public ERR getERR(int rep)

Returns a specific repetition of ERR (Error) - 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.

getERRReps

public int getERRReps()

Returns the number of existing repetitions of ERR

getERRAll

public List<ERR> getERRAll()
                    throws HL7Exception

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

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

Throws:

HL7Exception

insertERR

public void insertERR(ERR structure,
             int rep)
               throws HL7Exception

Inserts a specific repetition of ERR (Error)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

insertERR

public ERR insertERR(int rep)
              throws HL7Exception

Inserts a specific repetition of ERR (Error)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

removeERR

public ERR removeERR(int rep)
              throws HL7Exception

Removes a specific repetition of ERR (Error)

Throws:

HL7Exception

See Also:

AbstractGroup#removeRepetition(String, int)

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_M05_MF_QUERY getMF_QUERY()

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

getMF_QUERY

public MFR_M05_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

getMF_QUERYAll

public List<MFR_M05_MF_QUERY> getMF_QUERYAll()
                                      throws HL7Exception

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

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

Throws:

HL7Exception

insertMF_QUERY

public void insertMF_QUERY(MFR_M05_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_M05_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_M05_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