ca.uhn.hl7v2.model.v25.message

Class RSP_K31

java.lang.Object

ca.uhn.hl7v2.model.AbstractStructure

ca.uhn.hl7v2.model.AbstractGroup

ca.uhn.hl7v2.model.AbstractMessage

ca.uhn.hl7v2.model.v25.message.RSP_K31

All Implemented Interfaces:

Group, Message, Structure, Serializable

public class RSP_K31
extends AbstractMessage

Represents a RSP_K31 message structure (see chapter 4.13.20). This structure contains the following elements:

• 1: MSH (Message Header)
• 2: MSA (Message Acknowledgment)
• 3: ERR (Error) optional repeating
• 4: SFT (Software Segment) optional repeating
• 5: QAK (Query Acknowledgment)
• 6: QPD (Query Parameter Definition)
• 7: RCP (Response Control Parameter)
• 8: RSP_K31_RESPONSE (a Group object) repeating
• 9: 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
RSP_K31() Creates a new RSP_K31 message with DefaultModelClassFactory.
RSP_K31(ModelClassFactory factory) Creates a new RSP_K31 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
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
RCP	getRCP() Returns RCP (Response Control Parameter) - creates it if necessary
RSP_K31_RESPONSE	getRESPONSE() Returns the first repetition of RESPONSE (a Group object) - creates it if necessary
RSP_K31_RESPONSE	getRESPONSE(int rep) Returns a specific repetition of RESPONSE (a Group object) - creates it if necessary
List<RSP_K31_RESPONSE>	getRESPONSEAll() Returns a non-modifiable List containing all current existing repetitions of RESPONSE.
int	getRESPONSEReps() Returns the number of existing repetitions of RESPONSE
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)
RSP_K31_RESPONSE	insertRESPONSE(int rep) Inserts a specific repetition of RESPONSE (a Group object)
void	insertRESPONSE(RSP_K31_RESPONSE structure, int rep) Inserts a specific repetition of 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)
ERR	removeERR(int rep) Removes a specific repetition of ERR (Error)
RSP_K31_RESPONSE	removeRESPONSE(int rep) Removes a specific repetition of 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

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

RSP_K31

public RSP_K31()

Creates a new RSP_K31 message with DefaultModelClassFactory.

RSP_K31

public RSP_K31(ModelClassFactory factory)

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

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)

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)

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

getRESPONSE

public RSP_K31_RESPONSE getRESPONSE()

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

getRESPONSE

public RSP_K31_RESPONSE getRESPONSE(int rep)

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

getRESPONSEReps

public int getRESPONSEReps()

Returns the number of existing repetitions of RESPONSE

getRESPONSEAll

public List<RSP_K31_RESPONSE> getRESPONSEAll()
                                      throws HL7Exception

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

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

Throws:

HL7Exception

insertRESPONSE

public void insertRESPONSE(RSP_K31_RESPONSE structure,
                  int rep)
                    throws HL7Exception

Inserts a specific repetition of RESPONSE (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

insertRESPONSE

public RSP_K31_RESPONSE insertRESPONSE(int rep)
                                throws HL7Exception

Inserts a specific repetition of RESPONSE (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

removeRESPONSE

public RSP_K31_RESPONSE removeRESPONSE(int rep)
                                throws HL7Exception

Removes a specific repetition of RESPONSE (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup#removeRepetition(String, int)

getDSC

public DSC getDSC()

Returns DSC (Continuation Pointer) - creates it if necessary