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


/**
 *  OSM_R26 - Unsolicited Specimen Shipment Manifest Message (Event R26).
 *  The OSM_R26 Unsolicited Specimen Shipment Manifest message is used to communicate the contents of a
 *  specimen shipment to a specimen receiver (typically a laboratory).  
 *  <p>Represents a OSM_R26 message structure (see chapter 7.18.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) <b>SINGLE OPTIONAL</b><br/>
 *  7: SHIPMENT (a Group of segments in OSM_R26 message) <b>MULTIPLE_COMPLSARY</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 OSM_R26 extends Message{

	
	/**
	 * Constructs the OSM_R26 message.
	 */
	public OSM_R26(IMap objMessageMap) {
		super(objMessageMap, EnumMessageCode.OSM.getValue(), EnumTriggerEvent.R26.getValue(), EnumMessageStructure.OSM_R26.getValue());
	}
	
	/**
	 * Adds Software Segment(SFT) to this message.
	 * @param objSFT Specified Software Segment(SFT)to be added in 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 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;
	}
	
	/**
	 * 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 Collection of Shipment GROUP present in this message.
	 * @return ISingleCollection<Group> - Collection of Shipment Group present 
	 */
	public ISingleCollection<IGroup> getShipmentGroups()
	{
		return getGroup(EnumSegments.HL7_GROUP_SHIPMENT);
	}

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

	/**
	 * Add Shipment GROUP to this message.0
	 * @param objGroup Specified Shipment GROUP. 
	 */
	public void addShipmentGroup(IGroup objGroup)
	{
		addGroup(EnumSegments.HL7_GROUP_SHIPMENT, objGroup);
	}
}
