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

import cdac.medinfo.sdk.hl7282.baselibs.messages.Message;
import cdac.medinfo.sdk.hl7282.baselibs.segments.EQU;
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;

/**
 * EAC_U07 - Automated Equipment Command (Event U07).
 * This message is use to sent equipment commands from one application
 * to another (e.g., a Laboratory Automation System to automated Equipment).
 * <p>Represents a EAC_U07 message structure (see chapter 13.3.7). 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>
 * 3: EQU (Equipment Detail Segment) <b>SINGLE_COMPULSARY</b><br>
 * 4: COMMAND (a Group of segments in EAC_U07 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>EAC_U07 objU07 = (EAC_U07)MessageFactory.createInstance().createSendSupportedMessage("EAC", "U07");</p>
 */
public final class EAC_U07 extends Message 
{


	/**
	 * Constructs the EAC_U07 message.
	 */
	EAC_U07(IMap objMessageMap) 
	{
		super(objMessageMap, EnumMessageCode.EAC.getValue(), EnumTriggerEvent.U07.getValue(), EnumMessageStructure.EAC_U07.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 Equipment Detail(EQU) segment present in this message
	 * @return EQU - the EQU Segment present in this message or null if unavailable.
	 */
	public EQU getEquipmentDetailSegment()
	{
		ISingleCollection<ISegment> objSingleCollection = getSegment(EnumSegments.HL7_SEG_EQU);
		if(objSingleCollection != null)
			return (EQU)objSingleCollection.elementAt(0);
		return null;
	}

	/**
	 * Sets value of Equipment Detail segment for this message,overwrites if already present.
	 * @param objEQU Specified EQU Segment 
	 */
	public void setEquipmentDetailSegment(EQU objEQU)
	{
			setSegment(EnumSegments.HL7_SEG_EQU,objEQU);
	}

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

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

	/**
	 * Adds COMMAND GROUP to this message.
	 * @param objGroup Specified COMMAND GROUP. 
	 */
	public void addCommandGroup(IGroup objGroup)
	{
		addGroup(EnumSegments.HL7_GROUP_COMMAND, objGroup);
	}
}