javadoc comments corrected for all methods

git-svn-id: http://15.206.35.175/svn/proteus/business-java/trunk@213007 ce508802-f39f-4f6c-b175-0d175dae99d5

webitm-dis/src/ibase/webitm/ejb/dis/DistCommon.java

@@ -42,7 +42,7 @@ public class DistCommon {
 	E12GenericUtility genericUtility = new E12GenericUtility();
 
 	/**
-	 * Returns String tax_chap, tax_class, tax_env, price_list or price_list__clg
+	 * Gets the String tax_chap, tax_class, tax_env, price_list or price_list__clg
 	 * 
 	 * @param siteCodeFrom
 	 *            The code of from site
@@ -964,7 +964,7 @@ public class DistCommon {
 		// Culculate the trantype value from disparm
 
 	/**
-	 * Returns the string of disparm variable if not defined returns "NULLFOUND"
+	 * Gets  the string of disparm variable if not defined returns "NULLFOUND"
 	 * 
 	 * @param prdCode
 	 *            The period code ususaaly "999999" (which means applicable to all
@@ -1008,7 +1008,7 @@ public class DistCommon {
 	}// End of disparm
 
 	/**
-	 * Returns the price list type as a string
+	 * Gets the price list type as a string
 	 * 
 	 * @param priceList
 	 *            The price list for which type is to be identified
@@ -1052,7 +1052,7 @@ public class DistCommon {
 	// /////////////////////////////////
 
 	/**
-	 * Returns the rate as double
+	 * Gets the rate as double
 	 * 
 	 * @param priceList
 	 *            The price list for which type is to be identified
@@ -1903,6 +1903,14 @@ public class DistCommon {
 		return (rate);
 	}// pickRate()
 
+	/**
+	 * Gets tokenised string
+	 * 
+	 * @param tokenString
+	 * @param delimiter
+	 * @return
+	 * @throws ITMException
+	 */
 	public String getTokenList(String tokenString, String delimiter) throws ITMException {
 		String returnList = "";
 		if (tokenString != null && tokenString.length() > 0 && tokenString != "") {
@@ -1920,7 +1928,7 @@ public class DistCommon {
 	}// getTokenList()
 
 	/**
-	 * Returns the rate as double
+	 * Gets the rate as double
 	 * 
 	 * @param priceList
 	 *            The price list for which type is to be identified
@@ -3027,7 +3035,7 @@ public class DistCommon {
 	}// pickRate()
 
 	/**
-	 * Returns the rate as double
+	 * Gets the rate as double
 	 * 
 	 * @param priceList
 	 *            The price list for which type is to be identified
@@ -3747,6 +3755,19 @@ public class DistCommon {
 		return (rate);
 	}// pickRate()
 
+	/**
+	 * Gets the rate as double consiring the GSM
+	 * 
+	 * @param priceList
+	 * @param trDate
+	 * @param itemCode
+	 * @param aLotNo
+	 * @param listType
+	 * @param quantity
+	 * @param conn
+	 * @return
+	 * @throws ITMException
+	 */
 	public double pickRateGSM(String priceList, String trDate, String itemCode, String aLotNo, String listType,
 			double quantity, Connection conn) throws ITMException {
 		PreparedStatement pstmt = null;
@@ -4426,7 +4447,7 @@ public class DistCommon {
 	}// pickRateGSM()
 
 	/**
-	 * Returns the conversion factor as double
+	 * Gets the conversion factor as double
 	 * 
 	 * @param unitFrom
 	 *            The unit of measure from which to convert
@@ -4571,7 +4592,7 @@ public class DistCommon {
 	}// convQtyFactor
 
 	/**
-	 * Returns the conversion factor and converted value as an ArrayList(0)
+	 * Gets the conversion factor and converted value as an ArrayList(0)
 	 * conversion factor ArraList(1) converted value
 	 * 
 	 * @param unitFrom
@@ -4751,7 +4772,7 @@ public class DistCommon {
 	}
 
 	/**
-	 * Returns the rounded value as double
+	 * gets the rounded value as double
 	 * 
 	 * @param newQty
 	 *            The value to be rounded
@@ -4825,7 +4846,7 @@ public class DistCommon {
 	}
 
 	/**
-	 * Returns the rounded value as double
+	 * gets the rounded value as double
 	 * 
 	 * @param actVal
 	 *            The value to be rounded
@@ -4900,7 +4921,7 @@ public class DistCommon {
 	 */
 
 	/**
-	 * Returns the conversion factor and converted value as an ArrayList(0)
+	 * Gets the conversion factor and converted value as an ArrayList(0)
 	 * conversion factor ArraList(1) converted value
 	 * 
 	 * @param unitFrom
@@ -5067,7 +5088,7 @@ public class DistCommon {
 	}
 
 	/**
-	 * Returns the integral quantity item, site and customer combination as per
+	 * Gets the integral quantity item, site and customer combination as per
 	 * business logic
 	 * 
 	 * @param custCode
@@ -5214,7 +5235,7 @@ public class DistCommon {
 	}
 
 	/**
-	 * Returns the item series (division) as String
+	 * gets the item series (division) as String
 	 * 
 	 * @param itemCode
 	 *            The item code
@@ -5390,7 +5411,7 @@ public class DistCommon {
 
 	// add new goArt with retur ArrayList
 	/**
-	 * Returns no. of articles, shipper quantity and integral quantity as an
+	 * Gets no. of articles, shipper quantity and integral quantity as an
 	 * ArrayList
 	 * 
 	 * @param siteCode
@@ -5663,7 +5684,7 @@ public class DistCommon {
 	// end of getNoArt
 	// start added by alam on 020209
 	/**
-	 * Returns no. of articles as int
+	 * gets no. of articles as int
 	 * 
 	 * @param siteCode
 	 *            The site code
@@ -6632,6 +6653,16 @@ public class DistCommon {
 		return errString;
 	}
 
+	/**
+	 * Gets the integral quantity
+	 * 
+	 * @param lsItemCode
+	 * @param lsTranType
+	 * @param lcQtyOrder
+	 * @param lsSiteCode
+	 * @param conn
+	 * @return
+	 */
 	public String gbfSetIntegralQty(String lsItemCode, String lsTranType, double lcQtyOrder, String lsSiteCode,
 			Connection conn) {
 		PreparedStatement pstmt = null;
@@ -6747,7 +6778,7 @@ public class DistCommon {
 
 	// migration of method getTacClass on 07/05/09
 	/**
-	 * Returns tax_class as String
+	 * Gets tax_class as String
 	 * 
 	 * @param supOrCust
 	 *            Supplier or customer (C/S)
@@ -6882,7 +6913,7 @@ public class DistCommon {
 	// migration of method getTaxEnv() on 07/05/09
 	// getTaxENV
 	/**
-	 * Returns tax_env as String
+	 * Gets tax_env as String
 	 * 
 	 * @param stationFrom
 	 *            Station code from
@@ -7234,7 +7265,7 @@ public class DistCommon {
 	// migration of method getCheckTaxEnvStatus() on 07/05/09
 
 	/**
-	 * Returns error code if status of tax environment is closed
+	 * Gets status of tax environment
 	 * 
 	 * @param taxEnv
 	 *            Tax environment
@@ -7363,7 +7394,7 @@ public class DistCommon {
 	} // get taxchap
 
 	/**
-	 * Returns tax_chap as String
+	 * Gets tax_chap as String
 	 * 
 	 * @param itemCode
 	 *            Item Code
@@ -7521,7 +7552,7 @@ public class DistCommon {
 	}
 
 	/**
-	 * Returns expiry date
+	 * Calculates and get the expiry date
 	 * 
 	 * @param date
 	 *            Date from which expiry date to be calculated
@@ -7556,7 +7587,7 @@ public class DistCommon {
 	// added by cpatil on 10/oct/12 start
 
 	/**
-	 * Returns the rate as double
+	 * Gets the rate as double
 	 * 
 	 * @param priceList
 	 *            The price list for which type is to be identified
@@ -8346,6 +8377,8 @@ public class DistCommon {
 	}
 
 	/**
+	 * Gets the rate as double
+	 * 
 	 * @param priceList
 	 * @param trDate
 	 * @param itemCode
@@ -9100,6 +9133,8 @@ public class DistCommon {
 	// added by cpatil on 10/oct/12 end
 	// Start added by chandrashekar on 10-aug-2016
 	/**
+	 * gets the rate in double considering reference number
+	 * 
 	 * @param priceList
 	 * @param trDate
 	 * @param itemCode
@@ -9977,6 +10012,8 @@ public class DistCommon {
 	// Added By Kaustubh on 14 Nov 2017 start
 
 	/**
+	 * Gets the sales pricelist
+	 * 
 	 * @param custCd
 	 * @param custCdDlv
 	 * @param siteCd
@@ -10287,6 +10324,8 @@ public class DistCommon {
 	}
 
 	/**
+	 * Gets the sales rate as double
+	 * 
 	 * @param pricelist
 	 * @param SiteCode
 	 * @param custCode
@@ -10488,6 +10527,8 @@ public class DistCommon {
 	}
 
 	/**
+	 * Gets the discount as double
+	 * 
 	 * @param priceList
 	 * @param orderDate
 	 * @param custCode
@@ -10621,6 +10662,7 @@ public class DistCommon {
 	}
 
 	/**
+	 * Gets empty string if the argumnet is null
 	 * @param input
 	 * @return
 	 */
@@ -10635,6 +10677,8 @@ public class DistCommon {
 
 	// Added by Anjali R. on[13/04/2018][To calculate rate][Start]
 	/**
+	 * Calculate the rate by evaluating formula expression
+	 *  
 	 * @param priceListTar
 	 * @param calcRate
 	 * @param calcMethod
@@ -10888,6 +10932,8 @@ public class DistCommon {
 	// private java.sql.Timestamp getTimeStamp(String dateStr) throws ITMException,
 	// Exception
 	/**
+	 * Gets timestamp from a string
+	 * 
 	 * @param dateStr
 	 * @return
 	 * @throws ITMException
@@ -10916,6 +10962,8 @@ public class DistCommon {
 	// Added by Anjali R. on[13/04/2018][To parse string value into Timestamp][End]
 	// Added by Anjali R. on[13/04/2018][To parse string value into double][Start]
 	/**
+	 * Gets double from sting
+	 * 
 	 * @param input
 	 * @return
 	 * @throws Exception
@@ -10942,6 +10990,8 @@ public class DistCommon {
 	// added by rupali on 30/04/19 for getting rate slab_no wise if ref_no is geting
 	// blank [start]
 	/**
+	 * Gets the maximum tax slab
+	 * 
 	 * @param priceList
 	 * @param trDate
 	 * @param itemCode