/*******************************************************************************
 *  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.ID;
import cdac.medinfo.sdk.hl7282.baselibs.NM;
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;

/**
 * ECD - Equipment Command Segment<p>
 * The equipment command segment contains the information required to notify the receiving component what 
 * is to happen. 
 * <p>Represents an HL7 ECD message segment. 
 * This segment has the following fields:</p><p>
 * ECD-1: Reference Command Number (NM)<b>Required</b><br> 
 * ECD-2: Remote Control Command (CWE)<b>Required</b><br> 
 * ECD-3: Response Required (ID)<b>Optional</b><br> 
 * ECD-4: Requested Completion Time (TQ)<b>Withdrawn</b><br> 
 * ECD-5: 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 ECD extends Segment   
{
	

	/**
	 * Constructs the ECD segment.
	 */
	public ECD()
	{super(EnumSegments.HL7_SEG_ECD);
	}

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

	/**
	 * Retrieves the Parameters.
	 * This field identify the parameters of the command.
	 * @return ISingleCollection<TX> - parameters
	 */
	public ISingleCollection<TX> getParameters() 
	{
		ISingleCollection<IDataType> objDataCollection =getDataType(1394);
		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 Reference Command Number.
	 * This field contains the unique identifier for this particular command that should 
	 * be used by the various components for future referral to this command.
	 * @return String - referenceCommandNumber
	 */
	public NM getReferenceCommandNumber() 
	{
		ISingleCollection<IDataType> objDataCollection =getDataType(1390);
		if(objDataCollection != null && objDataCollection.size() != 0) 
			return (NM)objDataCollection.elementAt(0);
		else
			return null;
	}

	/**
	 * Retrieves the  Remote Control Command.
	 * This field identify the command that the component is to initiate.
	 * @return CWE - remoteControlCommand
	 */
	public CWE getRemoteControlCommand() 
	{
		ISingleCollection<IDataType> objDataCollection =getDataType(1391);
		if(objDataCollection != null && objDataCollection.size() != 0) 
			return (CWE)objDataCollection.elementAt(0);
		else
			return null;
	}

	/**
	 * Retrieves the Response Required.
	 * This field identify the mode of synchronization that is to be used in relation to the execution of the command.
	 * @return String - responseRequired
	 */
	public ID getResponseRequired() 
	{
		ISingleCollection<IDataType> objDataCollection =getDataType(1392);
		if(objDataCollection != null && objDataCollection.size() != 0) 
			return (ID)objDataCollection.elementAt(0);
		else
			return null;
	}

	/**
	 * Add the Parameters.
	 * This field identifies the parameters of the command.
	 * @param strTextdata String to be passed identifies the parameters of the command.
	 */
	public void addParameters(String strTextdata) 
	{
		TX parameters  = (TX)getDataElement(1394);
		parameters.setValue(strTextdata);
		addParameters(parameters);
	}

	/**
	 * Add the Parameters.
	 * This field identifies the parameters of the command.
	 * @param objParameters Object of Parameters.
	 */
	public void addParameters(TX objParameters)
	{
		addDataType(1394,objParameters);
	}

	/**
	 * Set the Parameters.
	 * This field identify the parameters of the command.
	 * @param objParameters List of Parameters.
	 */
	@SuppressWarnings("unchecked")
	public void setParameters(ISingleCollection<TX> objParameters)
	{
		ISingleCollection<IDataType> objCollection = null;
		ISingleCollection<?> objUnknownCollection = (ISingleCollection<?>)objParameters;
		objCollection = (ISingleCollection<IDataType>)objUnknownCollection;
		setDataType(1394,objCollection);
	}

	/**
	 * Set the Reference Command Number.
	 * This field contains the unique identifier for this particular command that should 
	 * be used by the various components for future referral to this command.
	 * @param strSequenceNumberTestObservationMasterFile String to be passed as Sequence Number - Test/Observation Master File
	 */
	public void setReferenceCommandNumber(String strSequenceNumberTestObservationMasterFile) 
	{
		NM referenceCommandNumber  = (NM)getDataElement(1390);
		referenceCommandNumber.setValue(strSequenceNumberTestObservationMasterFile);
		setReferenceCommandNumber(referenceCommandNumber);
	}

	/**
	 * Set the Reference Command Number.
	 * This field contains the unique identifier for this particular command that should 
	 * be used by the various components for future referral to this command.
	 * @param objReferenceCommandNumber Object of Reference Command Number.
	 */
	public void setReferenceCommandNumber(NM objReferenceCommandNumber)
	{
		setDataType(1390,objReferenceCommandNumber);
	}

	/**
	 * Set the  Remote Control Command.
	 * This field identify the command that the component is to initiate.    
	 * @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 setRemoteControlCommand(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(1391);
		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);
		setRemoteControlCommand(cwe);
	}

	/**
	 * Set the Remote Control Command.
	 * This field identify the command that the component is to initiate.
	 * @param objRemoteControlCommand Object of Remote Control Command.
	 */
	public void setRemoteControlCommand(CWE objRemoteControlCommand)
	{
		setDataType(1391,objRemoteControlCommand);
	}

	/**
	 * Set the Response Required.
	 * This field identify the mode of synchronization that is to be used in relation to the execution of the command.
	 * @param strActionCode Specifies the the intent of the message    
	 */	
	public void setResponseRequired(String strActionCode)
	{
		ID responseRequired  = (ID)getDataElement(1392);
		responseRequired.setValue(strActionCode);
		setResponseRequired(responseRequired);
	}

	/**
	 * Set the Response Required.
	 * This field identify the mode of synchronization that is to be used in relation to the execution of the command.
	 * @param objResponseRequired Object of Response Required.
	 */
	public void setResponseRequired(ID objResponseRequired)
	{
		setDataType(1392,objResponseRequired);
	}

	/**
	 * 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 
	{
		/*
		 * Reference Command Number and Remote Control Command is required field.
		 */
		try
		{
			super.validate();

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