/*******************************************************************************
 *  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.dicommodel.modules;



import cdac.medinfo.sdk.dcm30_04.baselibs.Tag;
import cdac.medinfo.sdk.dcm30_04.commoninterface.IDataSet;
import cdac.medinfo.sdk.dcm30_04.commoninterface.ITag;
import cdac.medinfo.sdk.dcm30_04.enums.EnumApprovalStatus;

import cdac.medinfo.sdk.dcm30_04.exceptions.ConditionFailedException;
import cdac.medinfo.sdk.dcm30_04.exceptions.InvalidModuleException;
import cdac.medinfo.sdk.dcm30_04.exceptions.MandatoryMissingException;
import cdac.medinfo.sdk.dcm30_04.utils.DicomConfig;
import cdac.medinfo.sdk.dcm30_04.utils.DicomConstants;
import cdac.medinfo.sdk.dcm30_04.utils.DicomLogger;
import cdac.medinfo.sdk.dcm30_04.utils.ISingleCollection;
import cdac.medinfo.sdk.dcm30_04.utils.SingleCollection;

// TODO: Auto-generated Javadoc
/**
 \* This module describes attributes in Approval Module.
 */
public class ApprovalModule extends Module  
{


	/**
	 * The obj single collection.
	 */
	public static ISingleCollection<ITag> objSingleCollection = null;

	/**
	 * Instantiates a new approval module.
	 * 
	 * @param objIDataSet the obj i data set
	 */
	public ApprovalModule(IDataSet objIDataSet)
	{
		super(objIDataSet);
	}

	static
	{
		objSingleCollection = new SingleCollection<ITag>();
		objSingleCollection.add(new Tag(0x300E,0x0002));
		objSingleCollection.add(new Tag(0x300E,0x0004));
		objSingleCollection.add(new Tag(0x300E,0x0005));
		objSingleCollection.add(new Tag(0x300E,0x0008));
	}


	/**
	 * This method validates each Attribute in the Module according to the Type
	 * of the Attribute.Attributes are of 5 types.
	 * Type 1,Type 2 are Mandatory:
	 * Mandatory Attributes have to present in the Module.
	 * Type 1C,2C are Conditional:
	 * Conditional Attributes' presence depend on a condition.
	 * If the condition is satisfied the Attribute has to be present.
	 * Type 3 are Optional
	 * Optional Attributes can be added as and when required.
	 * 
	 * @return true, if validate module
	 * 
	 * @throws InvalidModuleException - If validation of Module fails
	 */
	public  boolean validateModule() throws InvalidModuleException
	{

		try
		{
			if(!isPresent(0x300E, 0x0002))
				throw new MandatoryMissingException("300E,0002");
			String strApprovalStatus = getApprovalStatus();
			if(strApprovalStatus != null)
			{
				if((strApprovalStatus.equals(EnumApprovalStatus.APPROVED.getValue()) || strApprovalStatus.equals(EnumApprovalStatus.REJECTED.getValue()))&& !isPresent(0x300E,0x0004))
					throw new ConditionFailedException("300E,0004 required if Approval Status (300E,0002) is " + EnumApprovalStatus.APPROVED.getValue() + " or " + EnumApprovalStatus.REJECTED.getValue());
				else if((strApprovalStatus.equals(EnumApprovalStatus.APPROVED.getValue()) || strApprovalStatus.equals(EnumApprovalStatus.REJECTED.getValue()))&& !isPresent(0x300E,0x0005))
					throw new ConditionFailedException("300E,0005 required if Approval Status (300E,0002) is " + EnumApprovalStatus.APPROVED.getValue() + " or " + EnumApprovalStatus.REJECTED.getValue());
				else if((strApprovalStatus.equals(EnumApprovalStatus.APPROVED.getValue()) || strApprovalStatus.equals(EnumApprovalStatus.REJECTED.getValue()))&& !isPresent(0x300E,0x0008))
					throw new ConditionFailedException("300E,0008 required if Approval Status (300E,0002) is " + EnumApprovalStatus.APPROVED.getValue() + " or " + EnumApprovalStatus.REJECTED.getValue());
			}
		}catch(MandatoryMissingException mme)
		{
			if(DicomConfig.createInstance().isLoggingOn())
				DicomLogger.getLogger().log(mme.getMessage());

			
				throw new InvalidModuleException(this.getClass().getSimpleName(),mme);

		}
		catch(ConditionFailedException cfe)
		{
			if(DicomConfig.createInstance().isLoggingOn())
				DicomLogger.getLogger().log(cfe.getMessage());

			
				throw new InvalidModuleException(this.getClass().getSimpleName(),cfe);

		}
		return true;
	}

	/**
	 * Sets Approval status at the time the SOP Instance was created.
	 * Enumerated Values:
	 * 1) APPROVED = Reviewer recorded that object met an implied criterion.
	 * 2) UNAPPROVED = No review of object has been recorded.
	 * 3) REJECTED = Reviewer recorded that object failed to meet an implied criterion.
	 * 
	 * @param enumApprovalStatus the enum approval status
	 */
	public void setApprovalStatus(EnumApprovalStatus  enumApprovalStatus)
	{
		/* Accept Approval Status in String format of type DS.
		 * 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
		 */
		addDataElement(0x300E, 0x0002, DicomConstants.DCM_DT_CS, enumApprovalStatus.getValue());
	}

	/**
	 * Retrieves Approval status at the time the SOP Instance was created.
	 * 
	 * @return String - String value of Approval status.
	 */ 
	public String getApprovalStatus()
	{
		Object objValue = getValue(0x300E,0x0002);
		if(objValue != null)
			return objValue.toString();
		return null;
	}

	/**
	 * Sets date on which object was reviewed. Required if Approval Status (300E,0002) is APPROVED or REJECTED.
	 * 
	 * @param strReviewDate String value of Review Date.
	 */
	public void setReviewDate(String strReviewDate)
	{
		/*Accept Review Date in String format of type DA.
		 * 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
		 */
		addDataElement(0x300E, 0x0004, DicomConstants.DCM_DT_DA, strReviewDate);
	}

	/**
	 * Retrieves date on which object was reviewed. Required if Approval Status (300E,0002) is APPROVED or REJECTED.
	 * 
	 * @return the review date
	 */ 
	public String getReviewDate()
	{
		Object objValue = getValue(0x300E,0x0004);
		if(objValue != null)
			return objValue.toString();
		return null;
	}

	/**
	 * Sets time at which object was reviewed. Required if Approval Status (300E,0002) is APPROVED or REJECTED.
	 * 
	 * @param strReviewTime String value of Review Time.
	 */
	public void setReviewTime(String strReviewTime)
	{
		/* Accept Review Time in String format of type TM.
		 * 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
		 */
		addDataElement(0x300E, 0x0005, DicomConstants.DCM_DT_TM, strReviewTime);
	}

	/**
	 * Retrieves time at which object was reviewed.
	 * 
	 * @return the review time
	 */ 
	public String getReviewTime()
	{
		Object objValue = getValue(0x300E,0x0005);
		if(objValue != null)
			return objValue.toString();
		return null;
	}

	/**
	 * Sets Name of person who reviewed object. Required if Approval Status (300E,0002) is APPROVED or REJECTED.
	 * 
	 * @param strReviewerName String value of Reviewer Name.
	 */
	public void setReviewerName(String strReviewerName)
	{
		/*Accept Reviewer Name in String format of type PN.
		 * 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
		 */
		addDataElement(0x300E, 0x0008, DicomConstants.DCM_DT_PN, strReviewerName);
	}

	/**
	 * Retrieves Name of person who reviewed object.
	 * 
	 * @return the reviewer name
	 */ 
	public String getReviewerName()
	{
		Object objValue = getValue(0x300E,0x0008);
		if(objValue != null)
			return objValue.toString();
		return null;
	}

	/**
	 * This method returns the vector of keys representing the DataElements that belong to this module.
	 * 
	 * @return vector of Tags - returns the vector containing the collection of tags
	 */
	public ISingleCollection<ITag> getVectorOfKeys()
	{
		return objSingleCollection;
	}
}
