Package ca.uhn.hl7v2.model.v251.message

Class RSP_Z90

java.lang.Object

ca.uhn.hl7v2.model.AbstractStructure

ca.uhn.hl7v2.model.AbstractGroup

ca.uhn.hl7v2.model.AbstractMessage

ca.uhn.hl7v2.model.v251.message.RSP_Z90

All Implemented Interfaces:

Group, Message, Structure, Visitable, Serializable

public class RSP_Z90
extends AbstractMessage

Represents a RSP_Z90 message structure (see chapter 5.9.2.4). This structure contains the following elements:

• 1: MSH (Message Header)
• 2: SFT (Software Segment) optional repeating
• 3: MSA (Message Acknowledgment)
• 4: ERR (Error) optional
• 5: QAK (Query Acknowledgment)
• 6: QPD (Query Parameter Definition)
• 7: RCP (Response Control Parameter)
• 8: RSP_Z90_QUERY_RESPONSE (a Group object) repeating
• 9: DSC (Continuation Pointer)

See Also:

• Serialized Form

Field Summary

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

log

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
DSC	getDSC()	Returns DSC (Continuation Pointer) - creates it if necessary
ERR	getERR()	Returns ERR (Error) - 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
QPD	getQPD()	Returns QPD (Query Parameter Definition) - creates it if necessary
RSP_Z90_QUERY_RESPONSE	getQUERY_RESPONSE()	Returns the first repetition of QUERY_RESPONSE (a Group object) - creates it if necessary
RSP_Z90_QUERY_RESPONSE	getQUERY_RESPONSE(int rep)	Returns a specific repetition of QUERY_RESPONSE (a Group object) - creates it if necessary
List<RSP_Z90_QUERY_RESPONSE>	getQUERY_RESPONSEAll()	Returns a non-modifiable List containing all current existing repetitions of QUERY_RESPONSE.
int	getQUERY_RESPONSEReps()	Returns the number of existing repetitions of QUERY_RESPONSE
RCP	getRCP()	Returns RCP (Response Control Parameter) - 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.1"
RSP_Z90_QUERY_RESPONSE	insertQUERY_RESPONSE(int rep)	Inserts a specific repetition of QUERY_RESPONSE (a Group object)
void	insertQUERY_RESPONSE(RSP_Z90_QUERY_RESPONSE structure, int rep)	Inserts a specific repetition of QUERY_RESPONSE (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)
RSP_Z90_QUERY_RESPONSE	removeQUERY_RESPONSE(int rep)	Removes a specific repetition of QUERY_RESPONSE (a Group object)
SFT	removeSFT(int rep)	Removes a specific repetition of SFT (Software Segment)

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

RSP_Z90

public RSP_Z90()

Creates a new RSP_Z90 message with DefaultModelClassFactory.

RSP_Z90

public RSP_Z90(ModelClassFactory factory)

Creates a new RSP_Z90 message with custom ModelClassFactory.

Method Details

getVersion

public String getVersion()

Returns "2.5.1"

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 ERR (Error) - creates it if necessary

getQAK

public QAK getQAK()

Returns QAK (Query Acknowledgment) - creates it if necessary

getQPD

public QPD getQPD()

Returns QPD (Query Parameter Definition) - creates it if necessary

getRCP

public RCP getRCP()

Returns RCP (Response Control Parameter) - creates it if necessary

getQUERY_RESPONSE

public RSP_Z90_QUERY_RESPONSE getQUERY_RESPONSE()

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

getQUERY_RESPONSE

public RSP_Z90_QUERY_RESPONSE getQUERY_RESPONSE(int rep)

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

getQUERY_RESPONSEReps

public int getQUERY_RESPONSEReps()

Returns the number of existing repetitions of QUERY_RESPONSE

getQUERY_RESPONSEAll

public List<RSP_Z90_QUERY_RESPONSE> getQUERY_RESPONSEAll()
                                                  throws HL7Exception

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

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

Throws:

HL7Exception

insertQUERY_RESPONSE

public void insertQUERY_RESPONSE(RSP_Z90_QUERY_RESPONSE structure,
 int rep)
                          throws HL7Exception

Inserts a specific repetition of QUERY_RESPONSE (a Group object)

Throws:

HL7Exception

See Also:

• AbstractGroup#insertRepetition(Structure, int)

insertQUERY_RESPONSE

public RSP_Z90_QUERY_RESPONSE insertQUERY_RESPONSE(int rep)
                                            throws HL7Exception

Inserts a specific repetition of QUERY_RESPONSE (a Group object)

Throws:

HL7Exception

See Also:

• AbstractGroup#insertRepetition(Structure, int)

removeQUERY_RESPONSE

public RSP_Z90_QUERY_RESPONSE removeQUERY_RESPONSE(int rep)
                                            throws HL7Exception

Removes a specific repetition of QUERY_RESPONSE (a Group object)

Throws:

HL7Exception

See Also:

• AbstractGroup.removeRepetition(String, int)

getDSC

public DSC getDSC()

Returns DSC (Continuation Pointer) - creates it if necessary