/*******************************************************************************
 *  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.EnumBrachyAccessoryDeviceType;
import cdac.medinfo.sdk.dcm30_04.exceptions.ConditionFailedException;
import cdac.medinfo.sdk.dcm30_04.exceptions.InvalidItemException;
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 Recorded Brachy Accessory Device Sequence Item.
 */
public class RecordedBrachyAccessoryDeviceSequenceItem extends Item  
{
	

	/**
	 * 
	 */
	private static final long serialVersionUID = 1L;

	/**
	 * This constructor creates the item and internal code sequence macro with default TransferSyntax 
	 */
	RecordedBrachyAccessoryDeviceSequenceItem()
	{
		super();
	}

	/**
	 * This constructor creates the item and internal code sequence macro with default TransferSyntax 
	 * and default DictionaryReader
	 * @param objITransferSyntax specifies the DICOM Standard defined TransfeSyntax
	 */
	RecordedBrachyAccessoryDeviceSequenceItem(ITransferSyntax objITransferSyntax)
	{
		super(objITransferSyntax);
	}

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

	/**
	 * Sets Identification number of the Brachy Accessory Device. The value of Brachy Accessory Device Number (300A,0262) 
	 * shall be unique within the Application Setup in which it is created.
	 * @param strReferencedBrachyAccessoryDeviceNumber String value of  Identification number of the Brachy Accessory Device.
	 */
	public void setReferencedBrachyAccessoryDeviceNumber(String strReferencedBrachyAccessoryDeviceNumber)
	{
		/* Accept the Referenced Brachy Accessory Device Number 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(0x3008,0x0122,strReferencedBrachyAccessoryDeviceNumber,getDictionaryReader());
		else
			objIDataElement = new ExplicitDE(0x3008,0x0122,DicomConstants.DCM_DT_IS, strReferencedBrachyAccessoryDeviceNumber);

		addDataElement(objIDataElement);
	}

	/**
	 * Retrieves Identification number of the Brachy Accessory Device.
	 * @return String - value of  Identification number of the Brachy Accessory Device.
	 */
	public String getReferencedBrachyAccessoryDeviceNumber()
	{
		Object objValue = getValue(0x3008,0x0122);
		if(objValue != null)
			return objValue.toString();
		return null;
	}

	/**
	 * Sets User or machine supplied identifier for Brachy Accessory Device.
	 * @param strBrachyAccessoryDeviceID String value of Brachy Accessory Device ID.
	 */
	public void setBrachyAccessoryDeviceID(String strBrachyAccessoryDeviceID)
	{
		/* Accept the Referenced Brachy Accessory Device ID of type SH.
		 * 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(0x300A,0x0263,strBrachyAccessoryDeviceID,getDictionaryReader());
		else
			objIDataElement = new ExplicitDE(0x300A,0x0263,DicomConstants.DCM_DT_SH, strBrachyAccessoryDeviceID);

		addDataElement(objIDataElement);
	}

	/**
	 * Retrieves User or machine supplied identifier for Brachy Accessory Device.
	 * @return String - value of User or machine supplied identifier for Brachy Accessory Device.
	 */
	public String getBrachyAccessoryDeviceID()
	{
		Object objValue = getValue(0x300A,0x0263);
		if(objValue != null)
			return objValue.toString();
		return null;
	}

	/**
	 * Sets Type of Brachy Accessory Device.
	 * Defined Terms: SHIELD, DILATATION, MOLD, PLAQUE, FLAB.
	 * @param enumBrachyAccessoryDeviceID Enum value of Brachy Accessory Device Type.
	 */
	public void setBrachyAccessoryDeviceType(EnumBrachyAccessoryDeviceType enumBrachyAccessoryDeviceID)
	{
		/* Accept the Referenced Brachy Accessory Device Type 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(0x300A,0x0264,enumBrachyAccessoryDeviceID.getValue(),getDictionaryReader());
		else
			objIDataElement = new ExplicitDE(0x300A,0x0264,DicomConstants.DCM_DT_CS, enumBrachyAccessoryDeviceID.getValue());

		addDataElement(objIDataElement);
	}

	/**
	 * Retrieves Type of Brachy Accessory Device.
	 * @return String - value of Type of Brachy Accessory Device.
	 */
	public String getBrachyAccessoryDeviceType()
	{
		Object objValue = getValue(0x300A,0x0264);
		if(objValue != null)
			return objValue.toString();
		return null;
	}

	/**
	 * Sets User-defined name for Brachy Accessory Device.
	 * @param strBrachyAccessoryDeviceName String value of User-defined name for Brachy Accessory Device.
	 */
	public void setBrachyAccessoryDeviceName(String strBrachyAccessoryDeviceName)
	{
		/* Accept the Brachy Accessory Device Name 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(0x300A,0x0266,strBrachyAccessoryDeviceName,getDictionaryReader());
		else
			objIDataElement = new ExplicitDE(0x300A,0x0266,DicomConstants.DCM_DT_LO, strBrachyAccessoryDeviceName);

		addDataElement(objIDataElement);
	}

	/**
	 * Retrieves User-defined name for Brachy Accessory Device.
	 * @return String - value of User-defined name for Brachy Accessory Device.
	 */
	public String getBrachyAccessoryDeviceName()
	{
		Object objValue = getValue(0x300A,0x0266);
		if(objValue != null)
			return objValue.toString();
		return null;
	}

	/**
	 * Validates all the attributes in {@link RecordedBrachyAccessoryDeviceSequenceItem} 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(0x3008,0x0122))
				throw new ConditionFailedException("3008,0122");
			if(!contains(0x300A,0x0263))
				throw new ConditionFailedException("300A,0263");
			if(!contains(0x300A,0x0264))
				throw new ConditionFailedException("300A,0264");
		}
		catch(ConditionFailedException cfe)
		{
			if(DicomConfig.createInstance().isLoggingOn())
			{
				DicomLogger.getLogger().log(cfe.getMessage());
			}
			throw new ValidationException(this.getClass().getSimpleName(),cfe);
		}
		return true;
	}
}
