/*******************************************************************************
 *  Copyright 2017 Centre for Development of Advanced Computing(C-DAC), Pune
 *  
 *  Licensed under the Apache License, Version 2.0 (the "License");
 *  you may not use this file except in compliance with the License.
 *  You may obtain a copy of the License at
 *  
 *    http://www.apache.org/licenses/LICENSE-2.0
 *  
 *  Unless required by applicable law or agreed to in writing, software
 *  distributed under the License is distributed on an "AS IS" BASIS,
 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *  See the License for the specific language governing permissions and
 *  limitations under the License.
 *******************************************************************************/
package cdac.medinfo.sdk.hl7282.hl7model.messages.masterfiles;

import cdac.medinfo.sdk.hl7282.baselibs.messages.Message;
import cdac.medinfo.sdk.hl7282.baselibs.segments.MFI;
import cdac.medinfo.sdk.hl7282.baselibs.segments.SFT;
import cdac.medinfo.sdk.hl7282.baselibs.segments.UAC;
import cdac.medinfo.sdk.hl7282.commoninterface.IGroup;
import cdac.medinfo.sdk.hl7282.commoninterface.ISegment;
import cdac.medinfo.sdk.hl7282.commoninterface.ISingleCollection;
import cdac.medinfo.sdk.hl7282.utils.EnumMessageCode;
import cdac.medinfo.sdk.hl7282.utils.EnumMessageStructure;
import cdac.medinfo.sdk.hl7282.utils.EnumSegments;
import cdac.medinfo.sdk.hl7282.utils.EnumTriggerEvent;
import cdac.medinfo.sdk.hl7282.utils.IMap;

/**
 * MFN_M02 - Master File Notification for Staff/Practitioner (event M02).
 * <p>Represents a MFN_M02 message structure (see chapter 8.7.1). This structure contains the 
 * following elements: </p>
 * 0: MSH (Message Header segment) <b>SINGLE_COMPULSARY</b><br>
 * 1: SFT (Software Segment) <b>MULTIPLE_OPTIONAL</b><br>
 * 2: UAC (User Authentication Credential Segment) <b>SINGLE_OPTIONAL</b><br>
 * 2: MFI (Master File Identification segment) <b>SINGLE_COMPULSARY</b><br>
 * 3: MF_STAFF (a Group in MFN_M02 message) <b>MULTIPLE_COMPULSARY</b><br>
 * 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. 
 *
 * <p>Following is the step to create message<br>
 * Before that, respective Message Source and Message Recipient to be set on Message Factory.</p>
 * <p>MFN_M02 objM02 = (MFN_M02)MessageFactory.createInstance().createSendSupportedMessage("MFN", "M02");</p>
 */
public final class MFN_M02 extends Message 
{



	/**
	 * Constructs the MFN_M02 message.
	 */
	MFN_M02(IMap objMessageMap)
	{
		super(objMessageMap, EnumMessageCode.MFN.getValue(), EnumTriggerEvent.M02.getValue(), EnumMessageStructure.MFN_M02.getValue());
	}

	
	/**
	 * Retrieves Collection of Software Segments(SFT) present in this message.
	 * @return ISingleCollection<SFT> - Collection of Software Segments(SFT) present in this message.
	 */
	@SuppressWarnings("unchecked")
	public ISingleCollection<SFT> getSoftwareSegments()
	{
		ISingleCollection<?> objSegmentCollection = getSegment(EnumSegments.HL7_SEG_SFT);
		return (ISingleCollection<SFT>)objSegmentCollection;
	}

	/**
	 * Adds Software Segment(SFT) to this message.
	 * @param objSFT Specified Software Segment(SFT) to be added in this messageto this message.
	 */
	public void addSoftwareSegment(SFT objSFT)
	{
		addSegment(EnumSegments.HL7_SEG_SFT, objSFT);
	}

	/**
	 * Adds collection of Software Segment(SFT) to this message.
	 * @param objSFTSegmentCollection Collection of Software Segments to add in this message
	 */
	@SuppressWarnings("unchecked")
	public void addSoftwareSegment(ISingleCollection<SFT>  objSFTSegmentCollection)
	{
		ISingleCollection<?> objSegmentCollection =  objSFTSegmentCollection;
		addSegment(EnumSegments.HL7_SEG_SFT, (ISingleCollection<ISegment>)objSegmentCollection);
	}
	
	/**
	 * Retrieves User Authentication Credential(UAC) segment present in this message
	 * @return UAC - the User Authentication Credential Segment present in this message or null if unavailable. 
	 */
	public UAC getUserAuthenticationCredentialSegment()
	{
		ISingleCollection<ISegment> objSingleCollection = getSegment(EnumSegments.HL7_SEG_UAC);
		if(objSingleCollection != null)
			return (UAC)objSingleCollection.elementAt(0);
		return null;
	}
	
	/**
	 * Sets value of User Authentication Credential(UAC) segment  for this message, overwrites if already present.
	 * @param objUAC Specified UAC Segment
	 */
	public void setUserAuthenticationCredentialSegment(UAC objUAC)
	{
		setSegment(EnumSegments.HL7_SEG_UAC,objUAC);
	}
	
	/**
	 * Retrieves Master File Identification (MFI) segment present in this message
	 * @return MFI - the Message Acknowledgment Segment present in this message or null if unavailable.
	 */
	public MFI getMasterFileIdentificationSegment()
	{
		ISingleCollection<ISegment> objSingleCollection = getSegment(EnumSegments.HL7_SEG_MFI);
		if(objSingleCollection != null)
			return (MFI)objSingleCollection.elementAt(0);
		return null;
	}

	/**
	 * Sets value of Master File Identification segment for this message,overwrites if already present.
	 * @param objMFI Specified Master File Identification Segment 
	 */
	public void setMasterFileIdentificationSegment(MFI objMFI)
	{
		setSegment(EnumSegments.HL7_SEG_MFI,objMFI);
	}

	
	/**
	 * Retrieves Collection of MF_STAFF GROUP present in this message.
	 * @return ISingleCollection<Group> - Collection of MF_STAFF  Group present in this Message.
	 */
	public ISingleCollection<IGroup> getMfStaffGroups()
	{
		return getGroup(EnumSegments.HL7_GROUP_MF_STAFF );
	}

	/**
	 * Adds Collection of MF_STAFF GROUP to this message.
	 * @param objSingleCollection Specified  MF_STAFF  GROUP Collection.
	 */
	public void addMfStaffGroups(ISingleCollection<IGroup> objSingleCollection)
	{
		addGroup(EnumSegments.HL7_GROUP_MF_STAFF, objSingleCollection);
	}

	/**
	 * Adds MF_STAFF GROUP to this message.
	 * @param objGroup Specified MF_STAFF GROUP. 
	 */
	public void addMfStaffGroup(IGroup objGroup)
	{
		addGroup(EnumSegments.HL7_GROUP_MF_STAFF , objGroup);
	}
}