javadoc comments added

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

webitm-mfg/ibase/webitm/ejb/mfg/MfgCommon.java

@@ -24,6 +24,15 @@ import ibase.webitm.ejb.dis.DistCommon;
  * Window - Preferences - Java - Code Style - Code Templates
  */
 public class MfgCommon {
+    /**
+     * Returns String stock option
+     *
+     * @param     siteCode  The code of site
+     * @param     itemCode  The code of the item 
+     * @param	  conn   Database connection
+     * @return    stock option 0 - non-stockable, 1 - itemwise and 2 - lotwise
+     * @exception ITMException, Exception 
+     */
 	public String chkStkOpt(String siteCode, String itemCode, Connection conn)  throws ITMException, Exception
 	{
 		String stkOpt = "", sql = "";
@@ -68,6 +77,15 @@ public class MfgCommon {
 		
 	}
 
+    /**
+     * Returns String QC required flag
+     *
+     * @param     siteCode  The code of site
+     * @param     itemCode  The code of the item 
+     * @param	  conn   Database connection
+     * @return    QC required flag N - No, Y -  Yes
+     * @exception ITMException, Exception 
+     */
 	public String chkQcReqd(String siteCode, String itemCode, Connection conn)  throws ITMException, Exception 
 	{
 		String qcReqd = "", sql = "";
@@ -109,6 +127,15 @@ public class MfgCommon {
 		return qcReqd;
 	}
 	
+    /**
+     * Returns String retest date required flag
+     *
+     * @param     siteCode  The code of site
+     * @param     itemCode  The code of the item 
+     * @param	  conn   Database connection
+     * @return    retest date required required flag N - No, Y -  Yes
+     * @exception ITMException, Exception 
+     */
 	public String chkAutoQcReqd(String siteCode, String itemCode, Connection conn)   throws ITMException, Exception
 	{
 		String autoQcReqd = "", sql = "";
@@ -150,6 +177,13 @@ public class MfgCommon {
 		return autoQcReqd;
 	}
 
+    /**
+     * Returns String retest date required flag
+     *
+     * @param     stDate  String date in application date format
+     * @return    the date in timestamp format
+     * @exception ITMException, Exception 
+     */
 	private Timestamp getTimestampFormat(String stDate)   throws ITMException, Exception
 	{
 		Timestamp tsDate = null;
@@ -169,6 +203,15 @@ public class MfgCommon {
 			return tsDate;
 	}
 	
+    /**
+     * Returns String retest date required flag
+     *
+     * @param     prdCode  String period code
+	 * @param     varName  String variable name
+	 * @param	conn Databse connection
+     * @return    String variable value, if not defined returns "NULLFOUND"
+     * @exception ITMException, Exception 
+     */
 	public String getEnvMfg(String prdCode, String varName, Connection conn)  throws ITMException, Exception
 	  {
 			String varValue = "";
@@ -203,7 +246,17 @@ public class MfgCommon {
 			return varValue;
 	  }
 	//  13/07/13 manoharan new method to get mfg_date,exp_date as ArrayList
-	public ArrayList getMfgExpDate(String tranId, String calledFrom, java.sql.Timestamp completionDate, Connection conn)   throws ITMException, Exception
+	 /**
+     * Returns ArrayList with manufacturing and expiry date
+     *
+     * @param     tranId  String workorder number
+	 * @param     calledFrom  String called from W - workorder, R - workorder receipt
+	 * @param	  completionDate Timestamp completion date
+	 * @param	conn Databse connection
+     * @return    ArrayList with manufacturing and expiry date
+     * @exception ITMException, Exception 
+     */
+public ArrayList getMfgExpDate(String tranId, String calledFrom, java.sql.Timestamp completionDate, Connection conn)   throws ITMException, Exception
 	{
 		ArrayList mfgExpList = new ArrayList<java.sql.Timestamp>();
 		ResultSet rs = null;