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

import cdac.medinfo.sdk.hl7282.baselibs.CWE;
import cdac.medinfo.sdk.hl7282.baselibs.DTM;
import cdac.medinfo.sdk.hl7282.baselibs.TX;
import cdac.medinfo.sdk.hl7282.commoninterface.IDataType;
import cdac.medinfo.sdk.hl7282.commoninterface.ISingleCollection;
import cdac.medinfo.sdk.hl7282.exceptions.FieldMissingException;
import cdac.medinfo.sdk.hl7282.exceptions.InvalidSegmentException;
import cdac.medinfo.sdk.hl7282.utils.EnumSegments;
import cdac.medinfo.sdk.hl7282.utils.SingleCollection;

/***
 * ECR - Equipment Command Response Segment <p>
 * The equipment command response segment contains the receiving component's response to the previously 
 * received command.
 * <p>Represents an HL7 ECR message segment. 
 * This segment has the following fields:</p><p>
 * ECR-1: Command Response (CWE)<b>Required</b><br> 
 * ECR-2: Date/Time Completed (DTM)<b>Required</b><br> 
 * ECR-3: Command Response Parameters (TX)<b>Optional</b><br><p>
 * This class provides mechanism to validate message against HL7 v 2.8.2 standard.
 * The class provides accessors & mutators for the elements mentioned above.
 * The class has validate method which validates Message against HL7 v 2.8.2 standard.
 *
 * <p>User can also create Segment through {@link SegmentFactory}
 */
 public class ECR extends Segment   
{
	

	/**
	 * Constructs the ECR segment.
	 */
	public ECR()
	{super(EnumSegments.HL7_SEG_ECR);
	}

	//Integer values used in getter/setter is unique item id defined 
	//for each attribute.

	/**
	 * Retrieves the Command Response.
	 * This field identify the response of the previously issued command.  
	 * @return CWE - commandResponse
	 */
	public CWE getCommandResponse() 
	{
		ISingleCollection<IDataType> objDataCollection =getDataType(1395);
		if(objDataCollection != null && objDataCollection.size() != 0) 
			return (CWE)objDataCollection.elementAt(0);
		else
			return null;
	}

	/**
	 * Retrieves the Command Response Parameters.
	 * This field identify any associated parameters that relate to the returned response command message.
	 * @return ISingleCollection<TX> - commandResponseParameters
	 */
	public ISingleCollection<TX> getCommandResponseParameters()
	{
		ISingleCollection<IDataType> objDataCollection =getDataType(1397);
		ISingleCollection<TX> objDataList = new SingleCollection<TX>();
		if(objDataCollection != null && objDataCollection.size() != 0)
		{
			for(IDataType objDataType : objDataCollection)
			{
				TX objTX = (TX)objDataType;
				objDataList.add(objTX);
			}
		}

		return objDataList;
	}

	/**
	 * Retrieves the Date Time Completed.
	 * This field contains the date and time that the receiving component completed the requested command.
	 * @return DTM - dateTimeCompleted
	 */
	public DTM getDateTimeCompleted() 
	{
		ISingleCollection<IDataType> objDataCollection =getDataType(1396);
		if(objDataCollection != null && objDataCollection.size() != 0) 
			return (DTM)objDataCollection.elementAt(0);
		else
			return null;
	}

	/**
	 * Set the Command Response.
	 * This field identify the response of the previously issued command.      
	 * @param strIdentifier Specifies of characters (the code) that uniquely identifies the item being referenced. 
	 * @param strText Specifies The descriptive or textual name of the identifier, e.g., myocardial infarction. 
	 * @param strNameOfCodingSystem Identifies the coding scheme being used in the identifier component.
	 * @param strAlternateIdentifier Specifies an alternate sequence of characters (the code) that uniquely identifies the item being referenced.
	 * @param strAlternateText Specifies the descriptive or textual name of the alternate identifier. See usage note in section introduction.
	 * @param strNameOfAlternateCodingSystem Identifies the coding scheme being used in the alternate identifier component. 
	 * @param strCodingSystemVersionID A sequence of characters that uniquely identifies a second alternate code.
	 * @param strAlternateCodingSystemVersionId This component carries the version for the coding system identified by components 4-6.
	 * @param strOriginalText The text as seen and/or selected by the user who entered the data.
	 * @param strSecondAlternateIdentifier A sequence of characters that uniquely identifies a second alternate code.
	 * @param strSecondAlternateText The descriptive or textual name of the alternate identifier.
	 * @param strNameofSecondAlternateCodingSystem Identifies the coding scheme being used in the alternate identifier component.
	 * @param strSecondAlternateCodingSystemVersionID This component carries the version for the coding system identified by components 10-12.
	 * @param strCodingSystemOID This component contains the ISO Object Identifier (OID) for the coding system or value set named in CWE.3.
	 * @param strValueSetOID This component contains the ISO Object Identifier (OID) to allow identification of the value set from which the value in CWE.1 is obtained.
	 * @param strValueSetVersionID This component carries the version for the value set identified by CWE.15. The version is a date. The date is the date/time that the value set being used was published.
	 * @param strAlternateCodingSystemOID This component contains the ISO Object Identifier (OID) for the coding system or value set named in CWE.6.
	 * @param strAlternateValueSetOID This component contains the ISO Object Identifier (OID) to allow identification of the value set from which the value in CWE.4 is obtained.
	 * @param strAlternateValueSetVersionID This component carries the version for the value set identified by CWE.18. The version is a date.
	 * @param strSecondAlternateCodingSystemOID This component contains the ISO Object Identifier (OID) for the coding system or value set named in CWE.12.
	 * @param strSecondAlternateValueSetOID This component contains the ISO Object Identifier (OID) to allow identification of the value set from which the value in CWE.10 is obtained.
	 * @param strSecondAlternateValueSetVersionID This component carries the version for the value set identified by CWE.21. The version is a date.
	 */
	public void setCommandResponse(String strIdentifier,String strText,String strNameOfCodingSystem,
			String strAlternateIdentifier,String strAlternateText,String strNameOfAlternateCodingSystem, String strCodingSystemVersionID, String 				strAlternateCodingSystemVersionId,
			String strOriginalText, String  strSecondAlternateIdentifier, String strSecondAlternateText, 
			String strNameofSecondAlternateCodingSystem, String strSecondAlternateCodingSystemVersionID, String strCodingSystemOID, String strValueSetOID,
			String strValueSetVersionID, String strAlternateCodingSystemOID, String strAlternateValueSetOID, String strAlternateValueSetVersionID,
			String  strSecondAlternateCodingSystemOID, String strSecondAlternateValueSetOID, String strSecondAlternateValueSetVersionID)
	{
		CWE cwe  = (CWE)getDataElement(1395);
		cwe.setIdentifier(strIdentifier);
		cwe.setText(strText);
		cwe.setNameOfCodingSystem(strNameOfCodingSystem);
		cwe.setAlternateIdentifier(strAlternateIdentifier);
		cwe.setAlternateText(strAlternateText);
		cwe.setNameOfAlternateCodingSystem(strNameOfAlternateCodingSystem); 
		cwe.setCodingSystemVersionID(strCodingSystemVersionID);
		cwe.setAlternateCodingSystemVersionId(strAlternateCodingSystemVersionId);
		cwe.setOriginalText(strOriginalText);
		cwe.setSecondAlternateIdentifier(strSecondAlternateIdentifier);
		cwe.setSecondAlternateText(strSecondAlternateText);
		cwe.setNameofSecondAlternateCodingSystem(strNameofSecondAlternateCodingSystem);
		cwe.setSecondAlternateCodingSystemVersionID(strSecondAlternateCodingSystemVersionID);
		cwe.setCodingSystemOID(strCodingSystemOID);
		cwe.setValueSetOID(strValueSetOID);
		cwe.setValueSetVersionID(strValueSetVersionID);
		cwe.setAlternateCodingSystemOID(strAlternateCodingSystemOID);
		cwe.setAlternateValueSetOID(strAlternateValueSetOID);
		cwe.setAlternateValueSetVersionID(strAlternateValueSetVersionID);
		cwe.setSecondAlternateCodingSystemOID(strSecondAlternateCodingSystemOID);
		cwe.setSecondAlternateValueSetOID(strSecondAlternateValueSetOID);
		cwe.setSecondAlternateValueSetVersionID(strSecondAlternateValueSetVersionID);
		setCommandResponse(cwe);
	}

	/**
	 * Set the Command Response.
	 * This field identify the response of the previously issued command.
	 * @param objCommandResponse Object of Command Response.
	 */
	public void setCommandResponse(CWE objCommandResponse)
	{
		setDataType(1395,objCommandResponse);
	}

	/**
	 * Add the Command Response Parameters.
	 * This field identify any associated parameters that relate to the returned response command message.
	 * @param strObservationDescription String to be passed identifies the parameters of the command.
	 */
	public void addCommandResponseParameters(String strObservationDescription) 
	{
		TX commandResponseParameters  = (TX)getDataElement(1397);
		commandResponseParameters.setValue(strObservationDescription);		
		addCommandResponseParameters(commandResponseParameters);
	}

	/**
	 * Add the Command Response Parameters.
	 * This field identify any associated parameters that relate to the returned response command message.
	 * @param objCommandResponseParameters Object of Command Response Parameters.
	 */
	public void addCommandResponseParameters(TX objCommandResponseParameters)
	{
		addDataType(1397,objCommandResponseParameters);
	}

	/**
	 * Set the Command Response Parameters.
	 * This field identify any associated parameters that relate to the returned response command message.
	 * @param objCommandResponseParametersList List of Command Response Parameters.
	 */
	@SuppressWarnings("unchecked")
	public void setCommandResponseParameters(ISingleCollection<TX> objCommandResponseParametersList)
	{
		ISingleCollection<IDataType> objCollection = null;
		ISingleCollection<?> objUnknownCollection = (ISingleCollection<?>)objCommandResponseParametersList;
		objCollection = (ISingleCollection<IDataType>)objUnknownCollection;
		setDataType(1397,objCollection);
	}

	/**
	 * Set the Date Time Completed.
	 * This field contains the date and time that the receiving component completed the requested command.
	 * @param strTime Specifies a point in time using a 24-hour clock notation. 
	 */
	public void setDateTimeCompleted(String strTime) 
	{
		DTM dateTimeCompleted  = (DTM)getDataElement(1396);
		dateTimeCompleted.setValue(strTime);
		setDateTimeCompleted(dateTimeCompleted);
	}


	public void setDateTimeCompleted(DTM objDateTimeCompleted)
	{
		setDataType(1396,objDateTimeCompleted);
	}

	/**
	 * Validates HL7 Message objects .
	 * Validate method checks for validation each and every segments in side the Message object against specified message Structure. 
	 * Validation checks include optionality of segment or group.
	 * It also verifies the number of times segment or group is repeated in message.
	 * e.g 
	 * {PSH} while parsing PSH segment validate method will check for its mandatory presence.
	 * [PSH] in this case validate will throw exception if one tries to enter more than one PSH segment.
	 * @return boolean - true or false.
	 * @throws InvalidSegmentException Throws when Segment Validation fails. 
	 */	
	@Override
	public boolean validate() throws InvalidSegmentException 
	{
		/*
		 * Command Response and Date/Time Completed is required field.
		 */
		try
		{
			super.validate();

			return true;
		}
		catch(FieldMissingException ex)
		{
			throw new InvalidSegmentException(enumSegments.getValue(),ex);
		}
	}
}