/*******************************************************************************
 *  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.BillingProcedureStepSequence;
import cdac.medinfo.sdk.dcm30_04.baselibs.BillingSuppliesandDevicesSequence;
import cdac.medinfo.sdk.dcm30_04.baselibs.DicomV3Factory;
import cdac.medinfo.sdk.dcm30_04.baselibs.FilmConsumptionSequence;
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.exceptions.InvalidModuleException;
import cdac.medinfo.sdk.dcm30_04.utils.DicomConstants;
import cdac.medinfo.sdk.dcm30_04.utils.ISingleCollection;
import cdac.medinfo.sdk.dcm30_04.utils.SingleCollection;

// TODO: Auto-generated Javadoc
/**
 \* This module describes the attributes in Billing and Material Management Codes Module.
 */
public class BillingandMaterialManagementCodesModule extends Module  
{

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


	/**
	 * Creates Annotation List Module with default initialization.
	 * 
	 * @param objIDataSet the obj i data set
	 */
	public BillingandMaterialManagementCodesModule(IDataSet objIDataSet)
	{
		super(objIDataSet);
	}

	static
	{
		objSingleCollection = new SingleCollection<ITag>();
		objSingleCollection.add(new Tag(0x0040,0x0320));
		objSingleCollection.add(new Tag(0x0040,0x0321));
		objSingleCollection.add(new Tag(0x0040,0x0324));

	}

	/**
	 * 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 - validation status as success or failure
	 * 
	 * @throws InvalidModuleException when the module is invalid
	 */
	public boolean validateModule() throws InvalidModuleException
	{
		//All Attributes are optional.
		return true;
	}

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

	/**
	 * Retrieves pre-initialized object of BillingProcedureStepSequence.If the module contains the sequence object
	 * it returns the same otherwise it creates the sequence adds to the module with proper initialization
	 * and then returns the object of sequence
	 * 
	 * @return BillingProcedureStepSequence - instance of Referenced Reference Image Sequence.
	 */
	public BillingProcedureStepSequence getBillingProcedureStepSequence()
	{
		BillingProcedureStepSequence objBillingProcedureStepSequence = (BillingProcedureStepSequence)getDicomValue(0x0040,0x0320);
		if(objBillingProcedureStepSequence == null)
		{
			/*
			 * If the sequence object is not present in the DataSet, a new sequence object is created and
			 * the TransferSyntax and DictionaryReader is set into it as it is set in the Module. This ensures that 
			 * the DataElements getting added in the DataSet follow the same TransferSyntax and use the same
			 * DictionaryReader object as that of the module.
			 */
			DicomV3Factory objDicomV3Factory = DicomV3Factory.createInstance();
			objBillingProcedureStepSequence = (BillingProcedureStepSequence)objDicomV3Factory.createSequence(0x0040,0x0320, objITransferSyntax, objIDictionaryReader);
			
			// This will add Data Element of SQ to the DataSet.
			addDataElement(0x0040,0x0320, DicomConstants.DCM_DT_SQ, objBillingProcedureStepSequence.getValue());
		}
		return objBillingProcedureStepSequence;
	}

	/**
	 * Retrieves pre-initialized object of FilmConsumptionSequence.If the module contains the sequence object
	 * it returns the same otherwise it creates the sequence adds to the module with proper initialization
	 * and then returns the object of sequence
	 * 
	 * @return FilmConsumptionSequence - instance of Referenced Reference Image Sequence.
	 */
	public FilmConsumptionSequence getFilmConsumptionSequence()
	{
		FilmConsumptionSequence objFilmConsumptionSequence = (FilmConsumptionSequence)getDicomValue(0x0040,0x0321);
		if(objFilmConsumptionSequence == null)
		{
			/*
			 * If the sequence object is not present in the DataSet, a new sequence object is created and
			 * the TransferSyntax and DictionaryReader is set into it as it is set in the Module. This ensures that 
			 * the DataElements getting added in the DataSet follow the same TransferSyntax and use the same
			 * DictionaryReader object as that of the module.
			 */
			DicomV3Factory objDicomV3Factory = DicomV3Factory.createInstance();
			objFilmConsumptionSequence = (FilmConsumptionSequence)objDicomV3Factory.createSequence(0x0040,0x0321, objITransferSyntax, objIDictionaryReader);
			
			// This will add Data Element of SQ to the DataSet.
			addDataElement(0x0040,0x0321, DicomConstants.DCM_DT_SQ, objFilmConsumptionSequence.getValue());
		}
		return objFilmConsumptionSequence;
	}

	/**
	 * Retrieves pre-initialized object of BillingSuppliesandDevicesSequence.If the module contains the sequence object
	 * it returns the same otherwise it creates the sequence adds to the module with proper initialization
	 * and then returns the object of sequence
	 * 
	 * @return BillingSuppliesandDevicesSequence - instance of Referenced Reference Image Sequence.
	 */
	public BillingSuppliesandDevicesSequence getBillingSuppliesandDevicesSequence()
	{
		BillingSuppliesandDevicesSequence objBillingSuppliesandDevicesSequence = (BillingSuppliesandDevicesSequence)getDicomValue(0x0040,0x0324);
		if(objBillingSuppliesandDevicesSequence == null)
		{
			/*
			 * If the sequence object is not present in the DataSet, a new sequence object is created and
			 * the TransferSyntax and DictionaryReader is set into it as it is set in the Module. This ensures that 
			 * the DataElements getting added in the DataSet follow the same TransferSyntax and use the same
			 * DictionaryReader object as that of the module.
			 */
			DicomV3Factory objDicomV3Factory = DicomV3Factory.createInstance();
			objBillingSuppliesandDevicesSequence = (BillingSuppliesandDevicesSequence)objDicomV3Factory.createSequence(0x0040,0x0324, objITransferSyntax, objIDictionaryReader);
			
			// This will add Data Element of SQ to the DataSet.
			addDataElement(0x0040,0x0324, DicomConstants.DCM_DT_SQ, objBillingSuppliesandDevicesSequence.getValue());
		}
		return objBillingSuppliesandDevicesSequence;
	}
}
