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

Class UDM_Q05

java.lang.Object

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

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

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

public final class UDM_Q05
extends AbstractQuery

UDM_Q05 - Unsolicited Display Message (Event Q05).

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: URD (Results/Update Definition) SINGLE_COMPULSARY
4: URS (Results/Update Selection Criteria) SINGLE_OPTIONAL
5: DSP (Disply Data)MULTIPLE_COMPULSARY
6: 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.

Following is the step to create message
Before that, respective Message Source and Message Recipient to be set on Message Factory.

UDM_Q05 objQ05 = (UDM_Q05)MessageFactory.createInstance().createSendSupportedMessage("UDM", "Q05");

Method Summary

Methods

Modifier and Type	Method and Description
void	addDisplayDataSegment(DSP objDSP) Adds the Display Data(DSP) to this message.
void	addDisplayDataSegments(ISingleCollection<DSP> objDSPSegmentCollection) Adds the collection of Display Data Segment(DSP) 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
DSP	getDisplayDataSegment() Retrieves the Display Data(DSP) 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	isQuery() Veifies whether message is Query.
void	setContinuationPointerSegment(DSC objDSC) Set the value of Continuation Pointer 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, isResponse, 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

isQuery

public boolean isQuery()

Veifies whether message is Query.

Overrides:

isQuery in class Message

Returns:

boolean true on success otherwiae false.

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

getDisplayDataSegment

public DSP getDisplayDataSegment()

Retrieves the Display Data(DSP) Segment present in this message

Returns:

DSP - the Disaplay Data Segment present in this message or null if unavailable.

addDisplayDataSegment

public void addDisplayDataSegment(DSP objDSP)

Adds the Display Data(DSP) to this message.

Parameters:

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

addDisplayDataSegments

public void addDisplayDataSegments(ISingleCollection<DSP> objDSPSegmentCollection)

Adds the collection of Display Data Segment(DSP) 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