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

/**
 * CM1 - Clinical Study Phase Master Segment<p>
 * Each Clinical Study Phase Master (CM1) segment contains the information about one 
 * phase of a study identified in the preceding CM0. This is an optional structure 
 * to be used if the study has more than one treatment or evaluation phase within it. 
 * <p>Represents an HL7 CM1 message segment. 
 * This segment has the following fields:</p><p>
 * CM1-1: Set ID - CM1 (SI)<b>Required</b><br> 
 * CM1-2: Study Phase Identifier (CWE)<b>Required</b><br> 
 * CM1-3: Description of Study Phase (ST)<b>Required</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 CM1 extends Segment    
{
	

	/**
	 * Constructs the CM1 segment.
	 */
	public CM1()
	{super(EnumSegments.HL7_SEG_CM1);
	}

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

	/**
	 * Retrieves the Description of Study Phase.
	 * This field contains a brief explanation for recipients to understand what the phase represents.
	 * @return ST - descriptionofStudyPhase
	 */
	public ST getDescriptionofStudyPhase() 
	{
		ISingleCollection<IDataType> objDataCollection =getDataType(1023);
		if(objDataCollection != null && objDataCollection.size() != 0) 
			return (ST)objDataCollection.elementAt(0);
		else
			return null;
	}

	/**
	 * Retrieves the Set ID CM1.
	 * This field contains a number that uniquely identify this 
	 * transaction for the purpose of adding, changing, or deleting the transaction.
	 * @return SI - setID_CM1
	 */
	public SI getSetID_CM1() 
	{
		ISingleCollection<IDataType> objDataCollection =getDataType(1021);
		if(objDataCollection != null && objDataCollection.size() != 0) 
			return (SI)objDataCollection.elementAt(0);
		else
			return null;
	}

	/**
	 * Retrieves the Study Phase Identifier.
	 * @return CWE - studyPhaseIdentifier
	 */
	public CWE getStudyPhaseIdentifier() 
	{
		ISingleCollection<IDataType> objDataCollection =getDataType(1022);
		if(objDataCollection != null && objDataCollection.size() != 0) 
			return (CWE)objDataCollection.elementAt(0);
		else
			return null;
	}

	/**
	 * Set the Description of Study Phase.
	 * This field contains a brief explanation for recipients to understand what the phase represents.
	 * @param strDescriptionofStudyPhase String which to set as Description of Study Phase
	 */ 
	public void setDescriptionofStudyPhase (String strDescriptionofStudyPhase) 
	{
		ST descriptionofStudyPhase  = (ST)getDataElement(1023);
		descriptionofStudyPhase.setValue(strDescriptionofStudyPhase); 
		setDescriptionofStudyPhase(descriptionofStudyPhase);

	} 

	/** 
	 * Set the Description of Study Phase.
	 * This field contains a brief explanation for recipients to understand what the phase represents.
	 * @param objdescriptionofStudyPhase Object of Description of Study Phase.
	 */ 
	public void setDescriptionofStudyPhase(ST objdescriptionofStudyPhase)
	{
		setDataType(1023,objdescriptionofStudyPhase);

	}
	/**
	 * Set the Set ID CM1.
	 * This field contains a number that uniquely identify this 
	 * transaction for the purpose of adding, changing, or deleting the transaction.
	 * @param strSetID_CM1 This field contains the number that identifies CM1 transaction.
	 */ 
	public void setSetID_CM1 (String strSetID_CM1) 
	{
		SI setID_CM1  = (SI)getDataElement(1021);
		setID_CM1.setValue(strSetID_CM1); 
		setSetID_CM1(setID_CM1);

	} 

	/** 
	 * Set the Set ID CM1.
	 * This field contains a number that uniquely identify this 
	 * transaction for the purpose of adding, changing, or deleting the transaction.
	 * @param objsetID_CM1 Object of Set ID CM1.
	 */ 
	public void setSetID_CM1(SI objsetID_CM1)
	{
		setDataType(1021,objsetID_CM1);

	}

	/**
	 * Set the Study Phase Identifier.
	 * @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 setStudyPhaseIdentifier(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(1022);
		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);
		setStudyPhaseIdentifier(cwe);

	} 

	/** 
	 * Set the Study Phase Identifier.
	 * @param objstudyPhaseIdentifier Object of Study Phase Identifier.
	 */ 
	public void setStudyPhaseIdentifier(CWE objstudyPhaseIdentifier)
	{
		setDataType(1022,objstudyPhaseIdentifier);

	}

	/**
	 * 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 Thrown when Segment Validation Fails.
	 */
	public boolean validate() throws InvalidSegmentException 
	{
		/*
		 * Set ID - CM1,Study Phase Identifier,Description of Study Phase are required fields.
		 */
		try
		{
			super.validate();

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