/*******************************************************************************
 *  Copyright 2017-2018 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.dcm30_04.baselibs;

import cdac.medinfo.sdk.dcm30_04.commoninterface.IDataElement;
import cdac.medinfo.sdk.dcm30_04.commoninterface.IDictionaryReader;
import cdac.medinfo.sdk.dcm30_04.commoninterface.ITransferSyntax;
import cdac.medinfo.sdk.dcm30_04.enums.EnumConsentforDistributionFlag;
import cdac.medinfo.sdk.dcm30_04.enums.EnumDistributionType;
import cdac.medinfo.sdk.dcm30_04.exceptions.ConditionFailedException;
import cdac.medinfo.sdk.dcm30_04.exceptions.InvalidItemException;
import cdac.medinfo.sdk.dcm30_04.exceptions.MandatoryMissingException;
import cdac.medinfo.sdk.dcm30_04.exceptions.ValidationException;
import cdac.medinfo.sdk.dcm30_04.utils.DicomConfig;
import cdac.medinfo.sdk.dcm30_04.utils.DicomConstants;
import cdac.medinfo.sdk.dcm30_04.utils.DicomLogger;

/**
* This item class contains the methods to set, get and validate the attribute present in Consent for Clinical Trial Use Sequence.
 */

public class ConsentforClinicalTrialUseSequenceItem extends Item  
{

	private static final long serialVersionUID = 1L;


	/**
	 * This constructor creates the item with default TransferSyntax 
	 */
	ConsentforClinicalTrialUseSequenceItem()
	{
		super();
	}


	/**
	 * This constructor creates the item with specified TransferSyntax 
	 * and default DictionaryReader
	 * @param objITransferSyntax specifies the DICOM Standard defined TransfeSyntax
	 */
	ConsentforClinicalTrialUseSequenceItem(ITransferSyntax objITransferSyntax)
	{
		super(objITransferSyntax);
	}

	/**
	 * This constructor creates ConsentforClinicalTrialUseSequenceItem with specified TransferSyntax and
	 * specified DictionaryReader
	 * @param objTransferSyntax specifies the DICOM Standard defined TransfeSyntax
	 * @param objDictionaryReader specifies the DICOM Dictionary reader to be used 
	 */
	ConsentforClinicalTrialUseSequenceItem(ITransferSyntax objTransferSyntax, IDictionaryReader objDictionaryReader)
	{
		super(objTransferSyntax,objDictionaryReader);
	}

	/**
	 * Validates all the attributes in Consent for Clinical Trial Use Sequence Item that are present in the DataSet
	 * @return boolean - Success -true, Failure - false
	 * @throws InvalidItemException throws InvalidItemException If Mandatory or Conditional element fails.
	 */
	public boolean validateForModule()  throws InvalidItemException
	{
		try
		{
			if(!contains(0x0012,0x0085))
				throw new MandatoryMissingException("0012,0085");
			if(contains(0x0012,0x0085) && (getDataForTag(0x0012,0x0085).getValue().equals(EnumConsentforDistributionFlag.YES) || getDataForTag(0x0012,0x0085).getValue().equals(EnumConsentforDistributionFlag.WITHDRAWN)) )
				if(!contains(0x0012,0x0084))
					throw new ConditionFailedException("0x0012,0x0084");
			if(contains(0x0012,0x0084) && getDataForTag(0x0012,0x0084).getValue().equals(EnumDistributionType.NAMED_PROTOCOL) )
				if(!contains(0x0012,0x0020))
					throw new ConditionFailedException("0x0012,0x0020");
		}
		catch(MandatoryMissingException me)
		{
			if(DicomConfig.createInstance().isLoggingOn())
			{
				DicomLogger.getLogger().log(me.getMessage());
			}
			throw new InvalidItemException(this.getClass().getSimpleName(),me);
		}
		catch(ConditionFailedException ce)
		{
			if(DicomConfig.createInstance().isLoggingOn())
			{
				DicomLogger.getLogger().log(ce.getMessage());
			}
			throw new ValidationException(this.getClass().getSimpleName(),ce); 
		}
		return true;
	}
	
	/**
	 * Sets type of Distribution.
	 * The type of distribution for which consent to distribute has been granted.
	 * Defined Terms:
	 * 1) NAMED_PROTOCOL.
	 * 2) RESTRICTED_REUSE.
	 * 3) PUBLIC_RELEASE.
	 * @param enumSetupDeviceType enum value of Distribution Type.
	 */
	public void setDistributionType(EnumDistributionType enumSetupDeviceType)
	{
		/* Accept the Distribution Type in String format of type CS.
		 * Read the Transfer Syntax and check if ImplicitDE or ExplicitDE to create
		 * Set the iGroupNumber and iElementNumber to ImplicitDE object 
		 * Set the iVRType
		 * Set length from the element
		 * Add this element to the Data Set
		 */
		IDataElement objIDataElement = null;
		if(objITransferSyntax.getVRTransferSyntax() == DicomConstants.DCM_VR_IMPLICIT)
			objIDataElement = new ImplicitDE(0x0012,0x0084, enumSetupDeviceType.getValue(),getDictionaryReader());
		else
			objIDataElement = new ExplicitDE(0x0012,0x0084,DicomConstants.DCM_DT_CS, enumSetupDeviceType.getValue());

		addDataElement(objIDataElement);


	}

	/**
	 * Return type of Distribution. 
	 * The type of distribution for which consent to distribute has been granted.
	 * @return String - value of Distribution Type.
	 */
	public String getDistributionType()
	{
		Object objValue = getValue(0x0012,0x0084);
		if(objValue != null)
			return objValue.toString();
		return null;
	}
	
	/**
	 * Sets Clinical Trial Protocol ID.
	 * The identifier of the protocol for which consent to distribute has been granted
	 * @param strClinicalTrialProtocolID String value of Clinical Trial Protocol ID.
	 */
	public void setClinicalTrialProtocolID(String strClinicalTrialProtocolID)
	{
		/* Accept the Clinical Trial Protocol ID in String format of type LO.
		 * Read the Transfer Syntax and check if ImplicitDE or ExplicitDE to create
		 * Set the iGroupNumber and iElementNumber to ImplicitDE object 
		 * Set the iVRType
		 * Set length from the element
		 * Add this element to the Data Set
		 */
		IDataElement objIDataElement = null;
		if(objITransferSyntax.getVRTransferSyntax() == DicomConstants.DCM_VR_IMPLICIT)
			objIDataElement = new ImplicitDE(0x0012,0x0020, strClinicalTrialProtocolID,getDictionaryReader());
		else
			objIDataElement = new ExplicitDE(0x0012,0x0020,DicomConstants.DCM_DT_LO, strClinicalTrialProtocolID);

		addDataElement(objIDataElement);
	}

	/**
	 * Return Clinical Trial Protocol ID.
	 * The identifier of the protocol for which consent to distribute has been granted
	 * @return String - value of Clinical Trial Protocol ID.
	 */
	public String getClinicalTrialProtocolID()
	{
		Object objValue = getValue(0x0012,0x0020);
		if(objValue != null)
			return objValue.toString();
		return null;
	}

	/**
	 * Sets type of Consent for Distribution Flag.
	 * Defined Terms:
	 * 1) NO.
	 * 2) YES.
	 * 3) WITHDRAWN.
	 * @param enumSetupDeviceType enum value of Consent for Distribution Flag.
	 */
	public void setConsentforDistributionFlag(EnumConsentforDistributionFlag enumSetupDeviceType)
	{
		/* Accept the Consent for Distribution Flag in String format of type CS.
		 * Read the Transfer Syntax and check if ImplicitDE or ExplicitDE to create
		 * Set the iGroupNumber and iElementNumber to ImplicitDE object 
		 * Set the iVRType
		 * Set length from the element
		 * Add this element to the Data Set
		 */
		IDataElement objIDataElement = null;
		if(objITransferSyntax.getVRTransferSyntax() == DicomConstants.DCM_VR_IMPLICIT)
			objIDataElement = new ImplicitDE(0x0012,0x0085, enumSetupDeviceType.getValue(),getDictionaryReader());
		else
			objIDataElement = new ExplicitDE(0x0012,0x0085,DicomConstants.DCM_DT_CS, enumSetupDeviceType.getValue());

		addDataElement(objIDataElement);


	}

	/**
	 * Return type of Consent for Distribution Flag. 
	 * @return String - value of Consent for Distribution Flag.
	 */
	public String getConsentforDistributionFlag()
	{
		Object objValue = getValue(0x0012,0x0085);
		if(objValue != null)
			return objValue.toString();
		return null;
	}

}
