cdac.medinfo.sdk.hl7282.hl7model.messages.query

Class RDY_K15_Common

java.lang.Object

cdac.medinfo.sdk.hl7282.baselibs.messages.Message

cdac.medinfo.sdk.hl7282.baselibs.messages.AbstractQuery

cdac.medinfo.sdk.hl7282.hl7model.messages.query.RDY_K15_Common

Direct Known Subclasses:

RDY_K15, RDY_Z98

public abstract class RDY_K15_Common
extends AbstractQuery

RDY_K15 - Dispense History (Event K15).

Represents a RDY_K15 message structure (see chapter 5.3.2.5). This structure contains the following elements:

0: MSH (Message Header) SINGLE_COMPULSARY
1: SFT (Software Segment) MULTIPLE_OPTIONAL
2: UAC (User Authentication Credential segment) SINGLE_OPTIONAL
3: MSA (Message Acknowledgment) SINGLE_COMPULSARY
4: ERR (Error) SINGLE_OPTIONAL
5: QAK (Query Acknowledgment) SINGLE_COMPULSARY
6: QPD (Query Parameter Definition) SINGLE_COMPULSARY
7: DSP (Display Data) MULTIPLE_OPTIONAL
8: DSC (Continuation Pointer) SINGLE_OPTIONAL
This class provides mechanism to validate message against HL7 v 2.8.2 standard. The class provides accessors & mutators for the elements mentioned above. These elements can be easily populated & populated values can be easily retrieved. The class has validate method which validates Message against HL7 v 2.8.2 standard.

Method Summary

Methods

Modifier and Type	Method and Description
void	addDisplayDataSegment(DSP objDSP) Adds the Display Data(DSP) segment to this message.
void	addDisplayDataSegments(ISingleCollection<DSP> objDSPSegmentCollection) Adds the collection of Display Data(DSP) segment to this message.
void	addSoftwareSegment(ISingleCollection<SFT> objSFTSegmentCollection) Adds the collection of Software Segment(SFT) to this message.
void	addSoftwareSegment(SFT objSFT) Adds the Software Segment(SFT) to this message.
DSC	getContinuationPointerSegment() Retrieves the Continuation Pointer(DSC) Segment present in this message
ISingleCollection<DSP>	getDisplayDataSegments() Retrieves the Collection of Display Data(DSP) segment present in this message.
ERR	getErrorSegment() Retrieves Error(ERR) segment present in this message
MSA	getMessageAcknowledgmentSegment() Retrieves Message Acknowledgment(MSA) segment present in this message
QAK	getQueryAcknowledgementSegment() Retrieves the Query Acknowledgement(QAK) Segment present in this message
QPD	getQueryParameterDefinitionSegment() Retrieves the Query Parameter Definition(QPD) Segment present in this message
ISingleCollection<SFT>	getSoftwareSegments() Retrieves the Collection of Software Segments(SFT) present in this message.
UAC	getUserAuthenticationCredentialSegment() Retrieves User Authentication Credential(UAC) segment present in this message
boolean	isResponse() Veifies whether message is Response.
void	setContinuationPointerSegment(DSC objDSC) Set the value of Continuation Pointer Segment for this message,overwrites if already present.
void	setErrorSegment(ERR objERR) Sets value of Error segment for this message,overwrites if already present.
void	setMessageAcknowledgmentSegment(MSA objMSA) Sets value of Message Acknowledgment segment for this message,overwrites if already present.
void	setQueryAcknowledgementSegment(QAK objQAK) Set the value of Query Acknowledgement Segment for this message,overwrites if already present.
void	setQueryParameterDefinitionSegment(QPD objQPD) Set the value of Query Parameter Definition Segment for this message,overwrites if already present.
void	setUserAuthenticationCredentialSegment(UAC objUAC) Sets value of User Authentication Credential(UAC) segment for this message, overwrites if already present.

Methods inherited from class cdac.medinfo.sdk.hl7282.baselibs.messages.AbstractQuery

getQueryIdentifier, getQuerySegments, isBatchRSPExpected, isCanceledQuery, isCanceledResponse, isDeferred, isInteractiveQuery, isInteractiveResponse, setIsCanceledQuery, setIsCanceledResponse, setIsInteractiveQuery, setIsInteractiveResponse

Methods inherited from class cdac.medinfo.sdk.hl7282.baselibs.messages.Message

contains, dumpMessage, dumpMessage, getACKMode, getGroup, getGroupMap, getHeader, getMessageCode, getMessageControlID, getMessageStructure, getQueryUserParameters, getSegment, getSegmentSet, getSubscriptionType, getTriggerEvent, isQuery, populate, removeGroup, removeSegment, removeSegment, removeSegmentAttribute, removeSegmentAttribute, removeSegmentAttribute, removeSegments, setHeader, setSubscriptionType, updateSegmentAttribute, updateSegmentAttribute, validate, writeToXML, writeToXML

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

isResponse

public boolean isResponse()

Veifies whether message is Response.

Overrides:

isResponse in class Message

Returns:

boolean

getSoftwareSegments

public ISingleCollection<SFT> getSoftwareSegments()

Retrieves the Collection of Software Segments(SFT) present in this message.

Returns:

ISingleCollection - Collection of Software Segments(SFT) present in this message.

addSoftwareSegment

public void addSoftwareSegment(SFT objSFT)

Adds the Software Segment(SFT) to this message.

Parameters:

objSFT - Specified Software Segment(SFT) to be added in this messageto this message.

addSoftwareSegment

public void addSoftwareSegment(ISingleCollection<SFT> objSFTSegmentCollection)

Adds the collection of Software Segment(SFT) to this message.

Parameters:

objSFTSegmentCollection - Collection of Software Segments to add in this message

getUserAuthenticationCredentialSegment

public UAC getUserAuthenticationCredentialSegment()

Retrieves User Authentication Credential(UAC) segment present in this message

Returns:

UAC - the User Authentication Credential Segment present in this message or null if unavailable.

setUserAuthenticationCredentialSegment

public void setUserAuthenticationCredentialSegment(UAC objUAC)

Sets value of User Authentication Credential(UAC) segment for this message, overwrites if already present.

Parameters:

objUAC - Specified UAC Segment

getMessageAcknowledgmentSegment

public MSA getMessageAcknowledgmentSegment()

Retrieves Message Acknowledgment(MSA) segment present in this message

Returns:

MSA - the Message Acknowledgment Segment present in this message or null if unavailable.

setMessageAcknowledgmentSegment

public void setMessageAcknowledgmentSegment(MSA objMSA)

Sets value of Message Acknowledgment segment for this message,overwrites if already present.

Parameters:

objMSA - Specified Message Acknowledgment Segment

getErrorSegment

public ERR getErrorSegment()

Retrieves Error(ERR) segment present in this message

Returns:

ERR - the Error Segment present in this message or null if unavailable.

setErrorSegment

public void setErrorSegment(ERR objERR)

Sets value of Error segment for this message,overwrites if already present.

Parameters:

objERR - Specified Error Segment

getQueryAcknowledgementSegment

public QAK getQueryAcknowledgementSegment()

Retrieves the Query Acknowledgement(QAK) Segment present in this message

Returns:

QAK - the Query Acknowledgement Segment present in this message or null if unavailable.

setQueryAcknowledgementSegment

public void setQueryAcknowledgementSegment(QAK objQAK)

Set the value of Query Acknowledgement Segment for this message,overwrites if already present.

Parameters:

objQAK - Specified Query Acknowledgement Segment

getQueryParameterDefinitionSegment

public QPD getQueryParameterDefinitionSegment()

Retrieves the Query Parameter Definition(QPD) Segment present in this message

Returns:

QPD - the Query Parameter Definition Segment present in this message or null if unavailable.

setQueryParameterDefinitionSegment

public void setQueryParameterDefinitionSegment(QPD objQPD)

Set the value of Query Parameter Definition Segment for this message,overwrites if already present.

Parameters:

objQPD - Specified Query Parameter Definition Segment

getDisplayDataSegments

public ISingleCollection<DSP> getDisplayDataSegments()

Retrieves the Collection of Display Data(DSP) segment present in this message.

Returns:

ISingleCollection - Collection of Display Data(DSP) Segment present in this message.

addDisplayDataSegment

public void addDisplayDataSegment(DSP objDSP)

Adds the Display Data(DSP) segment to this message.

Parameters:

objDSP - Specified Display Data(DSP) segement to this message.

addDisplayDataSegments

public void addDisplayDataSegments(ISingleCollection<DSP> objDSPSegmentCollection)

Adds the collection of Display Data(DSP) segment to this message.

Parameters:

objDSPSegmentCollection - Collection of Display Data Segments to add in this message

getContinuationPointerSegment

public DSC getContinuationPointerSegment()

Retrieves the Continuation Pointer(DSC) Segment present in this message

Returns:

DSC - the Continuation Pointer Segment present in this message or null if unavailable.

setContinuationPointerSegment

public void setContinuationPointerSegment(DSC objDSC)

Set the value of Continuation Pointer Segment for this message,overwrites if already present.

Parameters:

objDSC - Specified Continuation Pointer Segment