javadoc comments corrected for all methods

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

webitm-fin/src/ibase/webitm/ejb/fin/FinCommon.java

@@ -40,9 +40,10 @@ public class FinCommon {
 	E12GenericUtility genericUtility = new E12GenericUtility();
 
 	/**
+	 * Update Sundry balance opening
 	 * @param sundrybalMap
 	 * @param conn
-	 * @return
+	 * @return empty string if successful else Error string 
 	 * @throws ITMException
 	 */
 	public String sundrybalOpnUpd(HashMap sundrybalMap, Connection conn) throws ITMException {
@@ -522,9 +523,10 @@ public class FinCommon {
 	}// sundrybalOpnUpd()
 
 	/**
+	 * Updates accout balance opening
 	 * @param acctbalMap
 	 * @param conn
-	 * @return
+	 * @return Empty string if successful else error string
 	 * @throws ITMException
 	 * @throws SQLException
 	 */
@@ -954,7 +956,7 @@ public class FinCommon {
 	}// acctbalOpnUpd()
 
 	/**
-	 * Returns updates sundry balance
+	 * Updates sundry balance
 	 *
 	 * @param sundrybalMap
 	 *            HashMap with sundry account details
@@ -1555,7 +1557,7 @@ public class FinCommon {
 	}// gbf_sundrybal_upd()
 
 	/**
-	 * Returns updates Account balance
+	 * updates Account balance
 	 *
 	 * @param acctbalMap
 	 *            HashMap with account details
@@ -2110,7 +2112,7 @@ public class FinCommon {
 	}// gbf_acctbal_upd()
 
 	/**
-	 * Returns finparm as String
+	 * Gets the value of finparm variable as String
 	 *
 	 * @param prdCode
 	 *            period code String
@@ -2170,7 +2172,7 @@ public class FinCommon {
 	}// getFinparams()
 
 	/**
-	 * Returns daily exchange rate from one currency to another
+	 * Gets daily exchange rate from one currency to another
 	 *
 	 * @param as_curr_code
 	 *            Currency code from
@@ -2517,7 +2519,7 @@ public class FinCommon {
 	}// getDailyExchRateSellBuy()
 
 	/**
-	 * Returns error code if account code is not valid
+	 * Validates the account code 
 	 *
 	 * @param siteCode
 	 *            Site code
@@ -2665,7 +2667,7 @@ public class FinCommon {
 	} // isAcctCode()
 
 	/**
-	 * Returns error code if cost center code is not valid
+	 * Validates cost center code
 	 *
 	 * @param acctCode
 	 *            Account code
@@ -2773,7 +2775,7 @@ public class FinCommon {
 	} // isAcctCode()
 
 	/**
-	 * Returns error code if sundry code is not valid
+	 * Validates sundry code
 	 *
 	 * @param siteCode
 	 *            Site code
@@ -2879,7 +2881,7 @@ public class FinCommon {
 	}
 
 	/**
-	 * Returns error code if strg customer code is not valid
+	 * Validates strategic customer code
 	 *
 	 * @param siteCode
 	 *            Site code
@@ -2939,7 +2941,7 @@ public class FinCommon {
 	}
 
 	/**
-	 * Returns error code if analysis code is not valid
+	 * Validate analysis code
 	 *
 	 * @param acctCode
 	 *            Account Code
@@ -3043,7 +3045,7 @@ public class FinCommon {
 	}
 
 	/**
-	 * Returns error code if loan party is not valid
+	 * Validates loan party code
 	 *
 	 * @param siteCode
 	 *            Site Code
@@ -3116,7 +3118,7 @@ public class FinCommon {
 	}
 
 	/**
-	 * Returns error code if tax authority is not valid
+	 * Validates Tax authority code
 	 *
 	 * @param siteCode
 	 *            Site Code
@@ -3162,7 +3164,7 @@ public class FinCommon {
 	}
 
 	/**
-	 * Returns error code if supplier code is not valid
+	 * Validates supplier code
 	 *
 	 * @param siteCode
 	 *            Site Code
@@ -3271,7 +3273,7 @@ public class FinCommon {
 	}
 
 	/**
-	 * Returns error code if employee code is not valid
+	 * Validates employee code
 	 *
 	 * @param siteCode
 	 *            Site Code
@@ -3331,7 +3333,7 @@ public class FinCommon {
 	}
 
 	/**
-	 * Returns error code if sales person code is not valid
+	 * Validates sales person code
 	 *
 	 * @param siteCode
 	 *            Site Code
@@ -3423,7 +3425,7 @@ public class FinCommon {
 	}
 
 	/**
-	 * Returns error code if account type is not valid
+	 * Validates account type
 	 *
 	 * @param acctCode
 	 *            Account Code
@@ -3512,7 +3514,7 @@ public class FinCommon {
 	}
 
 	/**
-	 * Returns error code if tax environment is not valid
+	 * Validates tax environment 
 	 *
 	 * @param taxEnv
 	 *            Tax environment
@@ -3609,7 +3611,7 @@ public class FinCommon {
 	}
 
 	/**
-	 * Returns the cheque name of the suchdry code
+	 * Gets the cheque name
 	 *
 	 * @param sundryType
 	 *            Sundry type
@@ -3869,7 +3871,7 @@ public class FinCommon {
 	}
 
 	/**
-	 * Returns the Account code and cost center code
+	 * Gets account and cost center codes
 	 *
 	 * @param itemCode
 	 *            Item code
@@ -5769,7 +5771,7 @@ public class FinCommon {
 	}
 
 	/**
-	 * Returns the Account code and cost center code
+	 * Gets account and cost center code considering the transaction type
 	 *
 	 * @param itemCode
 	 *            Item code
@@ -8140,7 +8142,7 @@ public class FinCommon {
 
 	/////////////
 	/**
-	 * Returns error code if update fails
+	 * Inserts gltrace table
 	 *
 	 * @param glTrace
 	 *            HashMap with account details
@@ -8156,7 +8158,7 @@ public class FinCommon {
 	}
 
 	/**
-	 * Returns error code if update fails
+	 * Inserts gltrace table or temporary gltrace_preview table
 	 *
 	 * @param glTrace
 	 *            HashMap with account details
@@ -8670,6 +8672,17 @@ public class FinCommon {
 	}
 
 	// Added By Dhiraj Chavan on 18-APR-2016
+	/**
+	 * Validates sitespecific cost center
+	 * 
+	 * @param siteCode
+	 * @param cctrCode
+	 * @param conn
+	 * @return
+	 * @throws ITMException
+	 * @throws SQLException
+	 * @throws RemoteException
+	 */
 	public String isSiteCctr(String siteCode, String cctrCode, Connection conn) throws ITMException// Added by Dhiraj
 																									// Chavan 18/04/16
 			, SQLException, RemoteException {
@@ -8764,7 +8777,7 @@ public class FinCommon {
 
 	// nvo_business_object_fin - gbf_get_project()
 	/**
-	 * Returns Project code from specified transaction
+	 * Gets Project code from specified transaction
 	 *
 	 * @param refSer
 	 *            Transaction series
@@ -8836,6 +8849,14 @@ public class FinCommon {
 	}
 
 	// nvo_business_object_fin - gbf_get_entry_batch_no()
+	/**
+	 * Gets entry batch number
+	 * 
+	 * @param refSer
+	 * @param periodCode
+	 * @return
+	 * @throws ITMException
+	 */
 	public String getEntryBatchNo(String refSer, String periodCode) throws ITMException// Added by Jiten
 	{
 		String entryBatchNo = "";
@@ -8867,7 +8888,7 @@ public class FinCommon {
 
 	// nvo_business_object_fin - gbf_gltran_upd()
 	/**
-	 * Returns updates gltran table
+	 * Updates gltran table
 	 *
 	 * @param glTran
 	 *            Hashap with account details
@@ -9459,7 +9480,7 @@ public class FinCommon {
 
 	// nvo_business_object_budget - gbf_gltrace_update_budget
 	/**
-	 * Returns Error code if fails
+	 * Updates budget with validation
 	 *
 	 * @param tranId
 	 *            Transaction Id
@@ -10647,6 +10668,15 @@ public class FinCommon {
 	}
 
 	// nvo_business_object_fin - gbf_check_gltran_drcr()
+	/**
+	 * Coampares debit and credit amount in gltrace_previw
+	 * 
+	 * @param refSer
+	 * @param refId
+	 * @param conn
+	 * @return error code if not matching
+	 * @throws ITMException
+	 */
 	public String checkGlTranDrCrPreview(String refSer, String refId, Connection conn) throws ITMException // Added by
 																											// Jiten
 	{
@@ -10797,6 +10827,13 @@ public class FinCommon {
 		return errString;
 	}
 
+	/**
+	 * Gets a double value with specified precision
+	 * 
+	 * @param actVal
+	 * @param prec
+	 * @return
+	 */
 	public double getRequiredDecimal(double actVal, int prec) // Added by Jiten
 	{
 		NumberFormat numberFormat = NumberFormat.getIntegerInstance();
@@ -12598,6 +12635,8 @@ public class FinCommon {
 	}
 
 	/**
+	 * Check period validity for date passed
+	 * 
 	 * @param modCode
 	 * @param refSer
 	 * @param tranDate
@@ -12959,6 +12998,8 @@ public class FinCommon {
 	}
 
 	/**
+	 * Validates bank code
+	 * 
 	 * @param siteCode
 	 * @param bankCode
 	 * @param modName
@@ -13068,6 +13109,8 @@ public class FinCommon {
 	}
 
 	/**
+	 * Validates site code
+	 * 
 	 * @param siteCode
 	 * @param modName
 	 * @param con
@@ -13114,6 +13157,8 @@ public class FinCommon {
 	}
 
 	/**
+	 * Validates financial entity
+	 * 
 	 * @param finEntity
 	 * @param modName
 	 * @param con
@@ -13161,6 +13206,8 @@ public class FinCommon {
 	}
 
 	/**
+	 * Validates customer code
+	 * 
 	 * @param siteCode
 	 * @param custCode
 	 * @param modName
@@ -13296,6 +13343,8 @@ public class FinCommon {
 
 	// Added by Varsha V for showing description message on 27-04-18
 	/**
+	 * Gets error xml with message trace added in the trace tag
+	 * 
 	 * @param messageValue
 	 * @param message
 	 * @param errorId
@@ -13343,6 +13392,8 @@ public class FinCommon {
 
 	// Added by Varsha V for showing description message on 30-04-18
 	/**
+	 * Gets the message from an exception
+	 * 
 	 * @param se
 	 * @param traceInfo
 	 * @return
@@ -13374,6 +13425,8 @@ public class FinCommon {
 	// Added by Anjali R. on[30/04/2018][Migrated method
 	// gbf_calc_discountdate][Start]
 	/**
+	 * Gets the discount date calculated as per mater definition
+	 * 
 	 * @param crTerm
 	 * @param tranDate
 	 * @param effDate
@@ -13599,6 +13652,8 @@ public class FinCommon {
 
 	// Added by Anjali R. on[30/04/2018][Migrated method gf_bankcharges_calc][Start]
 	/**
+	 * Calculates bank charges
+	 * 
 	 * @param bankCode
 	 * @param payMode
 	 * @param date
@@ -13738,6 +13793,8 @@ public class FinCommon {
 	// nvo_business_object_fin component][Start]
 
 	/**
+	 * Gets the payable at 
+	 * 
 	 * @param sundryType
 	 * @param sundryCode
 	 * @param bankCode
@@ -13902,6 +13959,8 @@ public class FinCommon {
 	// Added by Anjali R. on[02/05/2018][Migrated method gbf_stan_drawn from
 	// nvo_business_object_fin component][Start]
 	/**
+	 * Gets the station code on which the instrument is drawn
+	 * 
 	 * @param sundryType
 	 * @param sundryCode
 	 * @param conn
@@ -14066,6 +14125,8 @@ public class FinCommon {
 	// nvo_business_object_fin component][End]
 	// Added by Anjali R. on[21/09/2018][Validate sundry code ][Start]
 	/**
+	 * Gets the sundry code from the applicable sundry master
+	 * 
 	 * @param sundryCode
 	 * @param sundryType
 	 * @param conn
@@ -14237,6 +14298,8 @@ public class FinCommon {
 	// Added by Anjali R. on[21/09/2018][Validate sundry code ][eND]
 	// Added By PriyankaC to rounding the decimal.[Start]
 	/**
+	 * Gets rounded bigdecimal
+	 * 
 	 * @param aNumber
 	 * @param prec
 	 * @return
@@ -14249,6 +14312,7 @@ public class FinCommon {
 
 	// Added by Varsha V on 06-12-18 getAcctDetrtType with site code
 	/**
+	 * Gets account and cost center code 
 	 * @param itemCode
 	 * @param itemSer
 	 * @param purpose
@@ -14598,6 +14662,8 @@ public class FinCommon {
 	// Ended by Varsha V on 06-12-18 getAcctDetrtType with site code
 	// function change by pravin -- fi1fsun001 -- 01/05/12
 	/**
+	 * Calculates the due date
+	 * 
 	 * @param crTerm
 	 * @param tranDate
 	 * @param effDate
@@ -14769,6 +14835,8 @@ public class FinCommon {
 	}
 
 	/**
+	 * calculates the due date considering holidays
+	 * 
 	 * @param crTerm
 	 * @param adDueDate
 	 * @param siteCode