ca.uhn.hl7v2.model.v24.message

Class RSP_K25

java.lang.Object

ca.uhn.hl7v2.model.AbstractStructure

ca.uhn.hl7v2.model.AbstractGroup

ca.uhn.hl7v2.model.AbstractMessage

ca.uhn.hl7v2.model.v24.message.RSP_K25

All Implemented Interfaces:

Group, Message, Structure, Serializable

public class RSP_K25
extends AbstractMessage

Represents a RSP_K25 message structure (see chapter 15). This structure contains the following elements:

• 1: MSH (Message Header)
• 2: MSA (Message Acknowledgment)
• 3: ERR (Error) optional
• 4: QAK (Query Acknowledgment)
• 5: QPD (Query Parameter Definition)
• 6: RCP (Response Control Parameter)
• 7: RSP_K25_STAFF (a Group object) repeating
• 8: 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_K25() Creates a new RSP_K25 message with DefaultModelClassFactory.
RSP_K25(ModelClassFactory factory) Creates a new RSP_K25 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 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
RCP	getRCP() Returns RCP (Response Control Parameter) - creates it if necessary
RSP_K25_STAFF	getSTAFF() Returns the first repetition of STAFF (a Group object) - creates it if necessary
RSP_K25_STAFF	getSTAFF(int rep) Returns a specific repetition of STAFF (a Group object) - creates it if necessary
List<RSP_K25_STAFF>	getSTAFFAll() Returns a non-modifiable List containing all current existing repetitions of STAFF.
int	getSTAFFReps() Returns the number of existing repetitions of STAFF
String	getVersion() Returns "2.4"
RSP_K25_STAFF	insertSTAFF(int rep) Inserts a specific repetition of STAFF (a Group object)
void	insertSTAFF(RSP_K25_STAFF structure, int rep) Inserts a specific repetition of STAFF (a Group object)
RSP_K25_STAFF	removeSTAFF(int rep) Removes a specific repetition of STAFF (a Group object)

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

encode, fillResponseHeader, generateACK, generateACK, generateACK, getEncodingCharactersValue, getFieldSeparatorValue, getMessage, getParent, getParser, getValidationContext, initQuickstart, parse, printStructure, printStructure, setParser, setValidationContext, 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, 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, isChoiceElement, isGroup, isRepeating, isRequired

Methods inherited from interface ca.uhn.hl7v2.model.Structure

getName, isEmpty

Constructor Detail

RSP_K25

public RSP_K25()

Creates a new RSP_K25 message with DefaultModelClassFactory.

RSP_K25

public RSP_K25(ModelClassFactory factory)

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

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

getSTAFF

public RSP_K25_STAFF getSTAFF()

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

getSTAFF

public RSP_K25_STAFF getSTAFF(int rep)

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

getSTAFFReps

public int getSTAFFReps()

Returns the number of existing repetitions of STAFF

getSTAFFAll

public List<RSP_K25_STAFF> getSTAFFAll()
                                throws HL7Exception

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

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

Throws:

HL7Exception

insertSTAFF

public void insertSTAFF(RSP_K25_STAFF structure,
               int rep)
                 throws HL7Exception

Inserts a specific repetition of STAFF (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

insertSTAFF

public RSP_K25_STAFF insertSTAFF(int rep)
                          throws HL7Exception

Inserts a specific repetition of STAFF (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

removeSTAFF

public RSP_K25_STAFF removeSTAFF(int rep)
                          throws HL7Exception

Removes a specific repetition of STAFF (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup.removeRepetition(String, int)

getDSC

public DSC getDSC()

Returns DSC (Continuation Pointer) - creates it if necessary