cdac.medinfo.sdk.hl7282.hl7model.messages.masterfiles

Class MFN_M06

java.lang.Object

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

cdac.medinfo.sdk.hl7282.hl7model.messages.masterfiles.MFN_M06

public final class MFN_M06
extends Message

MFN_M06- Clinical Trials Master File Message (Event M06).

Represents a MFN_M06 message structure (see chapter 8.11.1). This structure contains the following elements:

0: MSH (Message Header segment) SINGLE_COMPULSARY
1: SFT (Software Segment) MULTIPLE_OPTIONAL
2: UAC (User Authentication Credential Segment) SINGLE_OPTIONAL
3: MFI (Master File Identification segment) SINGLE_COMPULSARY
4: MF_CLIN_STUDY (a Group in MFN_M06 message) MULTIPLE_COMPULSARY
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.

MFN_M06 objM06 = (MFN_M06)MessageFactory.createInstance().createSendSupportedMessage("MFN", "M06");

Method Summary

Methods

Modifier and Type	Method and Description
void	addMfClinStudyGroup(IGroup objGroup) Adds MF_CLIN_STUDY GROUP to this message.
void	addMfClinStudyGroups(ISingleCollection<IGroup> objSingleCollection) Adds Collection of MF_CLIN_STUDY GROUP to this message.
void	addSoftwareSegment(ISingleCollection<SFT> objSFTSegmentCollection) Adds collection of Software Segment(SFT) to this message.
void	addSoftwareSegment(SFT objSFT) Adds Software Segment(SFT) to this message.
MFI	getMasterFileIdentificationSegment() Retrieves Master File Identification (MFI) segment present in this message
ISingleCollection<IGroup>	getMfClinStudyGroups() Retrieves Collection of MF_CLIN_STUDY GROUP present in this message.
ISingleCollection<SFT>	getSoftwareSegments() Retrieves Collection of Software Segments(SFT) present in this message.
UAC	getUserAuthenticationCredentialSegment() Retrieves User Authentication Credential(UAC) segment present in this message
void	setMasterFileIdentificationSegment(MFI objMFI) Sets value of Master File Identification 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.Message

contains, dumpMessage, dumpMessage, getACKMode, getGroup, getGroupMap, getHeader, getMessageCode, getMessageControlID, getMessageStructure, getQueryUserParameters, getSegment, getSegmentSet, getSubscriptionType, getTriggerEvent, isQuery, 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

getSoftwareSegments

public ISingleCollection<SFT> getSoftwareSegments()

Retrieves 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 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 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

getMasterFileIdentificationSegment

public MFI getMasterFileIdentificationSegment()

Retrieves Master File Identification (MFI) segment present in this message

Returns:

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

setMasterFileIdentificationSegment

public void setMasterFileIdentificationSegment(MFI objMFI)

Sets value of Master File Identification segment for this message,overwrites if already present.

Parameters:

objMFI - Specified Master File Identification Segment

getMfClinStudyGroups

public ISingleCollection<IGroup> getMfClinStudyGroups()

Retrieves Collection of MF_CLIN_STUDY GROUP present in this message.

Returns:

ISingleCollection - Collection of MF_CLIN_STUDY Group present in this Message.

addMfClinStudyGroups

public void addMfClinStudyGroups(ISingleCollection<IGroup> objSingleCollection)

Adds Collection of MF_CLIN_STUDY GROUP to this message.

Parameters:

objSingleCollection - Specified MF_CLIN_STUDY GROUP Collection.

addMfClinStudyGroup

public void addMfClinStudyGroup(IGroup objGroup)

Adds MF_CLIN_STUDY GROUP to this message.

Parameters:

objGroup - Specified MF_CLIN_STUDY GROUP.