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

import cdac.medinfo.sdk.hl7282.baselibs.segmentfactory.DataElementFactory;
import cdac.medinfo.sdk.hl7282.commoninterface.IDataType;
import cdac.medinfo.sdk.hl7282.commoninterface.ISingleCollection;
import cdac.medinfo.sdk.hl7282.exceptions.InvalidComponentTypeException;
import cdac.medinfo.sdk.hl7282.exceptions.InvalidDataTypeException;
import cdac.medinfo.sdk.hl7282.exceptions.MissingValueException;
import cdac.medinfo.sdk.hl7282.utils.EnumDataType;
import cdac.medinfo.sdk.hl7282.utils.IDataTypeMap;

/**
 * PLN - Practitioner license or other Id number<p>
 * This data type specifies a practitioner's license number, or other ID number such as UPIN, Medicare 
 * and Medicaid number, and associated detail.
 * <p>Represents an HL7 PLN data type. 
 * This data type has the following attributes:</p><p>
 *  1. ID Number (ST)<b>Required</b><br>
 *  2. Type of ID Number (CWE)<b>Required</b><br>
 *  3. State/other Qualifying Information (ST)<b>Optional</b><br>
 *  4. Expiration Date (DT)<b>Optional</b><br><p>
 * This class provides accessors & mutators for the elements mentioned above.
 * This class override the equal method, to check whether some other object is "equal to" this one.
 * 
 * <p>User can also create Data Type through {@link DataElementFactory} 
 */
public class PLN extends CompositeDataType    
{
	

	/**
	 * Default Constructor for PLN
	 */
	public PLN()
	{
		super(EnumDataType.HL7_DT_PLN);
		 
	}

	/**
	 * Constructor  for CQ class which takes four arguments and 
	 * sets the value in the respective member variable.
	 * @param iMinLength The Minimum length the DataType can have.
	 * @param iMaxLength The Maximum length the DataType can have.
	 * @param iCLength The Conformance length the DataType can have.
	 * @param iComponentType The Type of the component i.e Component or a subcomponent.
	 * @throws InvalidComponentTypeException - if Component Type is not specified or valid. 
	 */ 
	public PLN(int iMinLength, int iMaxLength, String strCLength,int iComponentType) throws InvalidComponentTypeException
	{
		super(EnumDataType.HL7_DT_PLN);
		this.iMinLength = iMinLength;
		this.iMaxLength = iMaxLength;
		this.iConformanceLength = strCLength;
		this.iComponentType = iComponentType;
		if(!isValidComponentType())
		{
			throw new InvalidComponentTypeException(this.getClass().getSimpleName());
		}
	}

	/**
	 * Constructor for PLN class which takes five arguments and 
	 * sets the value in the respective member variable.
	 * @param iMinLength The Minimum length the DataType can have.
	 * @param iMaxLength The Maximum length the DataType can have.
	 * @param iCLength The Conformance length the DataType can have.
	 * @param iTableNo The Table number to which the value for the component is specified. 
	 * @param iComponentType The Type of the component i.e Component or a subcomponent.
	 * @throws InvalidComponentTypeException - if Component Type is not specified or valid. 
	 */
	public PLN(int iMinLength, int iMaxLength, String strCLength,int iTableNo,int iComponentType) throws InvalidComponentTypeException
	{
		super(EnumDataType.HL7_DT_PLN);
		this.iMinLength = iMinLength;
		this.iMaxLength = iMaxLength;
		this.iConformanceLength = strCLength;
		this.iTableNo = iTableNo;
		this.iComponentType = iComponentType;
		if(!isValidComponentType())
		{
			throw new InvalidComponentTypeException(this.getClass().getSimpleName());		
		}
	}
	/**
	 * Constructor for PLN class which takes two arguments and 
	 * sets the value in the respective member variable.
	 * @param objIDataTypeMap object of Data Type Map.
	 * @param iComponentType The Type of the component i.e Component or a subcomponent.
	 * @throws InvalidComponentTypeException - if Component Type is not specified or valid. 
	 */
	public PLN(int iComponentType,IDataTypeMap objIDataTypeMap)
	{
		super(EnumDataType.HL7_DT_PLN);
		this.objIDataTypeMap = objIDataTypeMap;
		this.iComponentType = iComponentType;
		if(!isValidComponentType())
		{
			throw new InvalidComponentTypeException(this.getClass().getSimpleName());
		}
	}
	/**
	 * Constructor for PLN class which takes five arguments and 
	 * sets the value in the respective member variable.
	 * @param objIDataTypeMap object of Data Type Map.
	 * @param iComponentType The Type of the component i.e Component or a subcomponent.
	 * @param iMinLength The Minimum length the DataType can have.
	 * @param iMaxLength The Maximum length the DataType can have.
	 * @param iCLength The Conformance length the DataType can have.
	 * @throws InvalidComponentTypeException - if Component Type is not specified or valid. 
	 */
	public PLN(int iComponentType,int iMinLength, int iMaxLength, String strCLength,IDataTypeMap objIDataTypeMap)
	{
		super(EnumDataType.HL7_DT_PLN);
		this.objIDataTypeMap = objIDataTypeMap;
		this.iComponentType = iComponentType;
		this.iMinLength = iMinLength;
		this.iMaxLength = iMaxLength;
		this.iConformanceLength = strCLength;

		if(!isValidComponentType())
		{
			throw new InvalidComponentTypeException(this.getClass().getSimpleName());
		}
	}
	/**
	 * Constructor for PLN class which takes six arguments and 
	 * sets the value in the respective member variable.
	 * @param objIDataTypeMap object of Data Type Map.
	 * @param iComponentType The Type of the component i.e Component or a subcomponent.
	 * @param iMinLength The Minimum length the DataType can have.
	 * @param iMaxLength The Maximum length the DataType can have.
	 * @param iCLength The Conformance length the DataType can have.
	 * @param iTableNo The Table number to which the value for the component is specified. 
	 * @throws InvalidComponentTypeException - if Component Type is not specified or valid. 
	 */
	public PLN(int iComponentType,int iMinLength, int iMaxLength, String strCLength,int ITableNo,IDataTypeMap objIDataTypeMap)
	{
		super(EnumDataType.HL7_DT_PLN);
		this.objIDataTypeMap = objIDataTypeMap;
		this.iComponentType = iComponentType;
		this.iTableNo = ITableNo;
		this.iMinLength = iMinLength;
		this.iMaxLength = iMaxLength;
		this.iConformanceLength = strCLength;

		if(!isValidComponentType())
		{
			throw new InvalidComponentTypeException(this.getClass().getSimpleName());
		}
	}



	/**
	 *Sets the IdNumber.
	 *@param strIdNumber Specifies the license number or other ID number such as UPIN, Medicare and Medicaid number. 
	 */
	public void setIdNumber(String strIdNumber)
	{
		if(strIdNumber!=null)
			setComponentType(1, strIdNumber);
		else
			setIdNumber((ST)null);
	}


	/**
	 *Sets the IdNumber.
	 *@param objST Specifies the license number or other ID number such as UPIN, Medicare and Medicaid number.
	 */
	public void setIdNumber(ST objST)
	{
		setComponentType(1,objST);
	}

	/**
	 *Sets the TypeOfIdNumber.
	 *@param strTypeOfIdNumber Specifies the type of number. 
	 */
	public void setTypeOfIdNumber(String strTypeOfIdNumber)
	{
		if(strTypeOfIdNumber!=null)
			setComponentType(2, strTypeOfIdNumber);
		else
			setTypeOfIdNumber((CWE)null);
	}
	
	/**
	 *Sets the TypeOfIdNumber.
	 *@param objCWE Specifies the type of number.
	 */
	public void setTypeOfIdNumber(CWE objCWE)
	{
		setComponentType(2,objCWE);
	}

	/**
	 *Sets the StateOtherQualifyingInformation.
	 *@param strStateOtherQualifyingInfo Specifies the state or province in which the license or ID is valid 
	 */
	public void setStateOtherQualifyingInformation(String strStateOtherQualifyingInfo)
	{
		if(strStateOtherQualifyingInfo!=null)
			setComponentType(3, strStateOtherQualifyingInfo);
		else
			setStateOtherQualifyingInformation((ST)null);
	}

	/**
	 *Sets the StateOtherQualifyingInformation.
	 *@param objST Specifies the state or province in which the license or ID is valid
	 */
	public void setStateOtherQualifyingInformation(ST objST)
	{
		setComponentType(3,objST);
	}

	/**
	 *Sets the ExpirationDate.
	 *@param strExpirationDate Specifies the date when the license or ID is no longer valid. 
	 */
	public void setExpirationDate(String strExpirationDate)
	{
		if(strExpirationDate!=null)
			setComponentType(4, strExpirationDate);
		else
			setExpirationDate((DT)null);
	}

	/**
	 *Sets the ExpirationDate.
	 *@param objDT Specifies the date when the license or ID is no longer valid.
	 */
	public void setExpirationDate(DT objDT)
	{
		setComponentType(4,objDT);
	}

	/**
	 * Returns ID Number
	 * @return ST - data type.
	 */
	public ST getIDNumber()
	{
		ISingleCollection<IDataType> objDataCollection =getComponentType(1);
		if(objDataCollection != null && objDataCollection.size() != 0) 
			return (ST)objDataCollection.elementAt(0);
		else
			return null;
	}

	/**
	 * Returns Type of ID Number
	 * @return CWE - data type.
	 */
	public CWE getTypeOfIDNumber()
	{
		ISingleCollection<IDataType> objDataCollection =getComponentType(2);
		if(objDataCollection != null && objDataCollection.size() != 0) 
			return (CWE)objDataCollection.elementAt(0);
		else
			return null;
	}

	/**
	 * Returns State/other Qualifying Information
	 * @return ST - data type.
	 */
	public ST getStateOtherQualifyingInformation()
	{
		ISingleCollection<IDataType> objDataCollection =getComponentType(3);
		if(objDataCollection != null && objDataCollection.size() != 0) 
			return (ST)objDataCollection.elementAt(0);
		else
			return null;
	}

	/**
	 * Returns Expiration Date
	 * @return DT - data type.
	 */
	public DT getExpirationDate()
	{
		ISingleCollection<IDataType> objDataCollection =getComponentType(4);
		if(objDataCollection != null && objDataCollection.size() != 0) 
			return (DT)objDataCollection.elementAt(0);
		else
			return null;
	}

	/**
	 * The Method validates the Input value,and if validated properly then returns true.
	 * Here the validetion is based on the compulsory fields for the Datatype. 
	 * @return boolean - true or false.
	 * @throws InvalidDataTypeException - if Invalid values is entered or Mandatory field is missing.
	 */
	public boolean validate() throws InvalidDataTypeException
	{
		super.validate();
		if(getComponentType(1)== null)
		{
			throw new MissingValueException(this.getClass().getSimpleName() + "ID Number");
		}	
		if(getComponentType(2)== null)
		{
			throw new MissingValueException(this.getClass().getSimpleName() + "Type of ID Number");
		}	
		else
			return true;
	}

	/**
	 * This method checks the equality of Object.
	 * @param objObject object of Object class.
	 * @return boolean - shows success or failure of the comparison.
	 */
	public boolean equals(Object objObject)
	{
		if((objObject == null ) || (!(objObject instanceof PLN)))
			return false;

		if(this.getIDNumber() == null)
		{
			if(((PLN)objObject).getIDNumber() != null)
				return false;
		}
		else if(false == (this.getIDNumber().equals(((PLN)objObject).getIDNumber())))
			return false;

		if(this.getTypeOfIDNumber() == null)
		{
			if(((PLN)objObject).getTypeOfIDNumber() != null)
				return false;
		}
		else if(false == (this.getTypeOfIDNumber().equals(((PLN)objObject).getTypeOfIDNumber())))
			return false;

		if(this.getStateOtherQualifyingInformation() == null)
		{
			if(((PLN)objObject).getStateOtherQualifyingInformation() != null)
				return false;
		}
		else if(false == (this.getStateOtherQualifyingInformation().equals(((PLN)objObject).getStateOtherQualifyingInformation())))
			return false;

		if(this.getExpirationDate() == null)
		{
			if(((PLN)objObject).getExpirationDate() != null)
				return false;
		}
		else if(false == (this.getExpirationDate().equals(((PLN)objObject).getExpirationDate())))
			return false;

		return true;
	}
}
