/*******************************************************************************
 *  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.observationreporting;

import cdac.medinfo.sdk.hl7282.baselibs.messages.Message;
import cdac.medinfo.sdk.hl7282.baselibs.segments.ERR;
import cdac.medinfo.sdk.hl7282.baselibs.segments.MSA;
import cdac.medinfo.sdk.hl7282.baselibs.segments.PRT;
import cdac.medinfo.sdk.hl7282.baselibs.segments.SFT;
import cdac.medinfo.sdk.hl7282.baselibs.segments.UAC;
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;


/**
 * ORA_R41 - Observation Report Alert Acknowledgement (Event R41).  
 * This message enables application level acknowledgements in response to the ORU^R40 alert observation message.
 * <p>Represents a ORA_R41 message structure (see chapter 7.3.13). 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) <b>SINGLE OPTIONAL</b><br/> 
 * 3: MSA (Message Acknowledgment) <b>SINGLE COMPULSARY</b><br>
 * 4: ERR (ERROR) <b> MULTIPLE OPTIONAL</b><br>
 * 5: PRT (Participation-Acknowledging User) <b> MULTIPLE OPTIONAL</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.
*/

public final class ORA_R41 extends Message{

	/**
	 * Constructs the ORA_R41 message.
	 */
	public ORA_R41(IMap objMessageMap) {
		super(objMessageMap, EnumMessageCode.ORA.getValue(), EnumTriggerEvent.R41.getValue(), EnumMessageStructure.ORA_R41.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 - Specified UAC Segment
	 */
	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 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 Message Acknowledgment(MSA) segment present in this message.
	 * @return MSA - the Message Acknowledgment Segment present in this message or null if unavailable.
	 */
	public MSA getMessageAcknowledgmentSegment()
	{
		ISingleCollection<ISegment> objSingleCollection = getSegment(EnumSegments.HL7_SEG_MSA);
		if(objSingleCollection != null)
			return (MSA)objSingleCollection.elementAt(0);
		return null;
	}

	/**
	 * Sets value of MSA segment for this message,overwrites if already present.
	 * @param objMSA Specified MSA Segment 
	 */
	public void setMessageAcknowledgmentSegment(MSA objMSA)
	{
		setSegment(EnumSegments.HL7_SEG_MSA,objMSA);
	}

	/**
	 * Retrieves Collection of Error(ERR) segment present in this message.
	 * @return ISingleCollection<ERR> - Collection of Error(ERR) segment present in this message.
	 */
	@SuppressWarnings("unchecked")
	public ISingleCollection<ERR> getSegments()
	{
		ISingleCollection<?> objSegmentCollection = getSegment(EnumSegments.HL7_SEG_ERR);
		return (ISingleCollection<ERR>)objSegmentCollection;
	}

	/**
	 * Adds Error(ERR) segment to this message.
	 * @param objERr Specified Error(ERR) segment to be added in this messageto this message.
	 */
	public void addErrorSegment(ERR objERR)
	{
		addSegment(EnumSegments.HL7_SEG_ERR, objERR);
	}

	/**
	 * Adds collection of Error(ERR) segment to this message.
	 * @param objERRSegmentCollection Collection of Error segment to add in this message
	 */
	@SuppressWarnings("unchecked")
	public void addErrorSegment(ISingleCollection<ERR>  objERRSegmentCollection)
	{
		ISingleCollection<?> objSegmentCollection =  objERRSegmentCollection;
		addSegment(EnumSegments.HL7_SEG_ERR, (ISingleCollection<ISegment>)objSegmentCollection);
	}
	
	/**
	 * Adds Participation(PRT) to this message.
	 * @param objPRT Specified Participation Segment to be added in message.
	 */
	public void addParticipationAcknowledgingUserSegment(PRT objPRT)
	{
		addSegment(EnumSegments.HL7_SEG_PRT, objPRT);
	}

	/**
	 * Adds collection of Participation(PRT) to this message.
	 * @param objPRTSegmentCollection Collection of Participation(PRT) to add in this message
	 */
	@SuppressWarnings("unchecked")
	public void addParticipationAcknowledgingUserSegment(ISingleCollection<PRT>  objPRTSegmentCollection)
	{
		ISingleCollection<?> objSegmentCollection =  objPRTSegmentCollection;
		addSegment(EnumSegments.HL7_SEG_PRT, (ISingleCollection<ISegment>)objSegmentCollection);
	}

	/**
	 * Retrieves Collection of Participation(PRT) present in this message.
	 * @return ISingleCollection<PRT> - Collection of Participation(PRT) present in this message.
	 */
	@SuppressWarnings("unchecked")
	public ISingleCollection<PRT> getParticipationAcknowledgingUserSegments()
	{
		ISingleCollection<?> objSegmentCollection = getSegment(EnumSegments.HL7_SEG_PRT);
		return (ISingleCollection<PRT>)objSegmentCollection;
	}

}
