/*******************************************************************************
 *  Copyright 2017 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.hl7282.utils;

/**
 * IAttributeItem needs to be implemented by class which defines structure of HL7 defined attributes for a Segment.
 */
public interface IAttributeItem 
{
	/**
	 * Retrieves name of attribute
	 * @return String - name of attribute
	 */
	String getFieldName();
	
	/**
	 * Sets name of attribute
	 * @param strName name of attribute
	 */
	void setFieldName(String strName);
	
	/**
	 * Retrieves Item ID for attribute defined by HL7 standard.
	 * @return int value of ItemID
	 */
	int getItemID();
	
	/**
	 * Sets Item ID for attribute defined by HL7 standard.
	 * @param intItemID value of ItemID
	 */
	void setItemID(int intItemID);
	
	/**
	 * Retrieves sequence number for attribute defined by HL7 standard in segment
	 * @return int - value of sequence index
	 */
	int getSequenceNo();
	
	/**
	 * Sets sequence number for attribute defined by HL7 standard in segment
	 * @param intSeq value of sequence index
	 */
	void setSequenceNo(int intSeq);
	
	/**
	 * Retrieves Maximum Length for attribute defined by HL7 standard in segment
	 * @return int - value of Maximum length
	 */
	int getMaximumLength();

	/**
	 * Sets Maximum Length for attribute defined by HL7 standard in segment
	 * @param maxLen Maximum length value
	 */
	void setMaximumLength(int maxLen);
	
	/**
	 * Retrieves Minimum Length for attribute defined by HL7 standard in segment
	 * @return int - value of Minimum length
	 */
	int getMinimumLength();
	
	/**
	 * Sets Minimum Length for attribute defined by HL7 standard in segment
	 * @param minLen Minimum length value
	 */
	void setMinimumLength(int minLen);
	
	/**
	 * Retrieves Conformance Length for attribute defined by HL7 standard in segment
	 * @return String - value of Conformance length
	 */
	String getConformanceLength();
	
	/**
	 * Sets Conformance Length for attribute defined by HL7 standard in segment
	 * @param cLen Conformance length value
	 */
	void setConformanceLength(String cLen);
		
	/**
	 * Retrieves Data Type for attribute defined by HL7 standard in segment
	 * @return String name of DataType
	 */
	String getDataType();
	
	/**
	 * Sets Datatype for attribute defined by HL7 standard in segment
	 * @param strDataType name of attribute
	 */
	void setDataType(String strDataType);
	
	/**
	 * Retrieves Table number for attribute defined by HL7 standard in segment
	 * @return int[] - array of table number
	 */
	int[] getTableNo() ;
	
	/**
	 * Sets Table number for attribute defined by HL7 standard in segment
	 * @param intTableNo array of table number
	 */
	void setTableNo(int[] intTableNo);
	
	/**
	 * Shows repeatability status for attribute defined by HL7 standard in segment
	 * @return boolean - status as true or false
	 */
	boolean isRepeatable();
	
	/**
	 * Retrieves Occurrence for attribute defined by HL7 standard in segment
	 * @return int - Number of Occurrence of the attribute
	 */
	int getOccurrence();
	
	/**
	 * Sets Occurrence for attribute defined by HL7 standard in segment
	 * @param intOccurrence Size of the attribute
	 */
	void setOccurrence(int intOccurrence);
	
	/**
	 * Sets repeatability status for attribute defined by HL7 standard in segment
	 * @param bRepeatable status as true or false
	 */
	void setRepeatable(boolean bRepeatable);
	
	/**
	 * Shows optionality status for attribute defined by HL7 standard in segment
	 * @return boolean - status as true or false
	 */
	boolean isOptional();
	
	/**
	 * Sets optionality status for attribute defined by HL7 standard in segment
	 * @param bOptional status as true or false
	 */
	void setOptional(boolean bOptional);
}
