/*******************************************************************************
 *  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.EnumReasonforOmission;
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 Omitted Beam Task Sequence.
 */

public class OmittedBeamTaskSequenceItem extends Item
{
		private static final long serialVersionUID = 1L;

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

	/*
	 * This constructor calls the respective superclass constructor
	 * This constructor should throw exception if null TS is tried to be set
	 */
	/**
	 * This constructor creates the item with specified TransferSyntax 
	 * and default DictionaryReader
	 * @param objITransferSyntax specifies the DICOM Standard defined TransfeSyntax
	 */
	OmittedBeamTaskSequenceItem(ITransferSyntax objITransferSyntax)
	{
		super(objITransferSyntax);
	}

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

	/*
	 * (non-Javadoc) This method validates the contents of the Item
	 * @see cdac.medinfo.sdk.dcm30_04.commoninterface.IItem#validate()
	 */
	/**
	 * Validates all the attributes in OmittedBeamTaskSequenceItem 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(0x300C,0x0006))
				throw new MandatoryMissingException("300C,0006");
			if(!contains(0x300C,0x0112))
				throw new MandatoryMissingException("300C,0112");
		}
		catch(MandatoryMissingException me)
		{
			if(DicomConfig.createInstance().isLoggingOn())
			{
				DicomLogger.getLogger().log(me.getMessage());
			}
			throw new ValidationException(this.getClass().getSimpleName(),me);
		}
		return true;
	}
		
	/**
	 * Sets Referenced Beam Number. 
	 * @param strReferencedBeamNumber String value of Referenced Beam Number.
	 */
	public void setReferencedBeamNumber(String strReferencedBeamNumber )
	{
		/*Accept the Referenced Beam Number in String format of type IS.
		 * 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(0x300C,0x0006, strReferencedBeamNumber ,getDictionaryReader());
		else
			objIDataElement = new ExplicitDE(0x300C,0x0006,DicomConstants.DCM_DT_IS, strReferencedBeamNumber );

		addDataElement(objIDataElement);
	}
	/**
	 * Retrieves Referenced Beam Number, 
	 * @return String - value of Referenced Beam Number.
	 */
	public String getReferencedBeamNumber()
	{
		Object objValue = getValue(0x300C,0x0006);
		if(objValue != null)
			return objValue.toString();
		return null;
	}
	
	/**
	 * Sets Reason for Omission.
	 * Reason why the referenced beam is not to be delivered and/or verified.
	 * Defined Terms:
	 * 1) ALREADY_TREATED
	 * @param enumReasonforOmission enum value of Reason for Omission.
	 */
	public void setReasonforOmission(EnumReasonforOmission enumReasonforOmission)
	{
		/* Accept the Reason for Omission 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(0x300C,0x0112, enumReasonforOmission.getValue(),getDictionaryReader());
		else
			objIDataElement = new ExplicitDE(0x300C,0x0112,DicomConstants.DCM_DT_CS, enumReasonforOmission.getValue());

		addDataElement(objIDataElement);

	}

	/**
	 * Return Reason for Omission. 
	 * Reason why the referenced beam is not to be delivered and/or verified.
	 * @return String - value of Reason for Omission.
	 */
	public String getReasonforOmission()
	{
		Object objValue = getValue(0x300C,0x0112);
		if(objValue != null)
			return objValue.toString();
		return null;
	}
	
	/**
	 * Sets Reason for Omission Description.
	 * @param strReasonforOmissionDescription String value of Reason for Omission Description.
	 */
	public void setReasonforOmissionDescription(String strReasonforOmissionDescription)
	{
		/* Accept the Reason for Omission Description 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(0x300C, 0x0113, strReasonforOmissionDescription,getDictionaryReader());
		else
			objIDataElement = new ExplicitDE(0x300C, 0x0113,DicomConstants.DCM_DT_LO, strReasonforOmissionDescription);

		addDataElement(objIDataElement);
	}

	/**
	 * Return Reason for Omission Description.
	 * @return String - value of Reason for Omission Description.
	 */
	public String getReasonforOmissionDescription()
	{
		Object objValue = getValue(0x300C, 0x0113);
		if(objValue != null)
			return objValue.toString();
		return null;
	}
	
}


