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

import java.io.Serializable;

/**
 * This interface needs to be implemented by all classes which implements the necessary functionality for the DictionaryReader.
 */
public interface IDictionaryReader extends Serializable
{
	/**
	 * Retrieves the status of Dictionary whether it is populated or not.
	 * @return boolean - true, when data dictionary is populated.
	 */
	boolean isDictionaryPopulated();

	/**
	 * Populates the Dictionary Data Provider with all the attributes from the Data Dictionary.
	 */
	void populate();

	/**
	 * Retrieves the name specified by Dicom Standard for the specified Tag.
	 * @param iGroupNumber Group Number of Tag.
	 * @param iElementNumber Element Number of Tag. 
	 * @return String - returns the name specified by Dicom Standard for the specified Tag.
	 */
	String getName(int iGroupNumber, int iElementNumber);

	/**
	 * Retrieves the VR Type specified by Dicom Standard for the specified Tag.
	 * VR Type represents the Value Representation for the specified Tag.
	 * @param iGroupNumber Group Number of Tag.
	 * @param iElementNumber Element Number of Tag. 
	 * @return String - returns the VR Type specified by Dicom Standard for the specified Tag.
	 */
	String getVR(int iGroupNumber, int iElementNumber);

	/**
	 * Retrieves the minimum Value Multiplicity specified by Dicom Standard for the specified Tag.
	 * VR Type represents the minimum Value Multiplicity for the specified Tag.
	 * @param iGroupNumber Group Number of Tag.
	 * @param iElementNumber Element Number of Tag.  
	 * @return integer  - returns the VM specified by Dicom Standard for the specified Tag.
	 */
	int getMinVM(int iGroupNumber, int iElementNumber);

	/**
	 * Retrieves the maximum Value Multiplicity specified by Dicom Standard for the specified Tag.
	 * VR Type represents the maximum Value Multiplicity for the specified Tag. 
	 * @param iGroupNumber Group Number of Tag.
	 * @param iElementNumber Element Number of Tag.
	 * @return integer  - returns the VM specified by Dicom Standard for the specified Tag.
	 */
	int getMaxVM(int iGroupNumber, int iElementNumber);

	/**
	 * Retrieves the status indicating whether the specified tag is retired from Dicom V3-2004 Standard Specification.
	 * @param iGroupNumber Group Number of Tag.
	 * @param iElementNumber Element Number of Tag. 
	 * @return boolean  - the status indicating whether the specified tag is retired from Dicom V3-2004 Standard Specification
	 */
	boolean isRetired(int iGroupNumber, int iElementNumber);

	/**
	 * Retrieves the  Group Number and Element Number of Attribute Name provided.
	 * This function return a short array in which element at index 0 is Group Number
	 * and at index 1 is Element Number. 
	 * @param strDataElementName String value of Data Element name.
	 * @return short[] - return short array. The element at index 0 represents Group Number and 
	 * at index 1 represents Element Number. 
	 */
	short[] getTag(String strDataElementName);
}
