java-doc comments added

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

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

@@ -633,6 +633,14 @@ public class FinCommon
 	return retString;
 	}//acctbalOpnUpd()
 
+    /**
+     * Returns updates sundry balance
+     *
+     * @param     sundrybalMap  HashMap with sundry account details
+     * @param	  conn   Database connection
+     * @return    Error code if fails
+     * @exception ITMException
+     */
 	public String gbf_sundrybal_upd(HashMap sundrybalMap, Connection conn)throws ITMException
 	{
 		String sql = "";
@@ -1033,6 +1041,14 @@ public class FinCommon
 	}//gbf_sundrybal_upd()
 
 
+    /**
+     * Returns updates Account balance
+     *
+     * @param     acctbalMap  HashMap with account details
+     * @param	  conn   Database connection
+     * @return    Error code if fails
+     * @exception ITMException
+     */
 	public String gbf_acctbal_upd(HashMap acctbalMap, Connection conn)throws ITMException
 	{
 		String retString = "";
@@ -1380,6 +1396,15 @@ public class FinCommon
 	return retString;
 	}//gbf_acctbal_upd()
 
+    /**
+     * Returns finparm as String
+     *
+     * @param     prdCode  period code String
+     * @param     varName  Variable name String
+     * @param	  conn   Database connection
+     * @return    "NULLFOUND" if not defined or error else variable value
+     * @exception ITMException
+     */
 	public String getFinparams(String prdCode,String varName,Connection conn)throws ITMException
 	{
 		String retVal="";
@@ -1431,6 +1456,18 @@ public class FinCommon
 		return(retVal);
 	}//getFinparams()
 
+    /**
+     * Returns daily exchange rate from one currency to another
+     *
+     * @param     as_curr_code  Currency code from
+     * @param     as_curr_code__to  Currency code to 
+     * @param     as_login_site  Login site code
+     * @param     as_tran_date  Transaction Date
+     * @param     as_type  B - Buying or S - Selling
+     * @param	  conn   Database connection
+     * @return    Exchange rate as double
+     * @exception ITMException
+     */
 	public double getDailyExchRateSellBuy(String as_curr_code,String as_curr_code__to,String as_login_site,String as_tran_date,String as_type,Connection conn)throws ITMException
 	{
 		String ls_fin_entity ="",ls_curr_code__to = "",var_value = "",type = "";
@@ -1683,6 +1720,16 @@ public class FinCommon
 		return lc_exch_rate;
 	}//getDailyExchRateSellBuy()
 
+    /**
+     * Returns error code if account code is not valid
+     *
+     * @param     siteCode  Site code 
+     * @param     acctCode  Account code
+     * @param     modName  Module name 
+     * @param	  con   Database connection
+     * @return    Error code if not valid
+     * @exception ITMException
+     */
 	public String isAcctCode(String siteCode,String acctCode,String modName,Connection con) throws ITMException
 	{
 		String errCode = "", siteSpec = "";
@@ -1802,6 +1849,16 @@ public class FinCommon
 		System.out.println("errCode ::: " + errCode);
 		return errCode;
 	}	// isAcctCode()
+    /**
+     * Returns error code if cost center code is not valid
+     *
+     * @param     acctCode  Account code
+     * @param     cctrCode  cost center code
+     * @param     modName  Module name 
+     * @param	  con   Database connection
+     * @return    Error code if not valid
+     * @exception ITMException
+     */
 	public String isCctrCode(String acctCode,String cctrCode,String modName,Connection con) throws ITMException
 	{
 		String errCode = "";
@@ -1904,6 +1961,17 @@ public class FinCommon
 		return errCode;
 	}	// isAcctCode()
 
+    /**
+     * Returns error code if sundry code is not valid
+     *
+     * @param     siteCode  Site code
+     * @param     sundryType  Sundry Type
+     * @param     sundryCode  Sundry code
+     * @param     refSer  Transaction Series
+     * @param	  conn   Database connection
+     * @return    Error code if not valid
+     * @exception ITMException
+     */
 	public String isSundryCode(String siteCode, String sundryType, String sundryCode, String refSer, Connection conn)
 	{
 		PreparedStatement pstmt = null;
@@ -2023,6 +2091,16 @@ public class FinCommon
 		return errCode;
 	}
 
+    /**
+     * Returns error code if strg customer code is not valid
+     *
+     * @param     siteCode  Site code
+     * @param     custCode  Customer code
+     * @param     refSer  Transaction Series
+     * @param	  conn   Database connection
+     * @return    Error code if not valid
+     * @exception ITMException
+     */
 	public String isStrgCustomer(String siteCode,String custCode,String refSer, Connection conn)
 	{
 		PreparedStatement pstmt = null;
@@ -2077,6 +2155,16 @@ public class FinCommon
 
 	}
 
+    /**
+     * Returns error code if analysis code is not valid
+     *
+     * @param     acctCode  Account Code
+     * @param     analCode  Analysis code
+     * @param     refSer  Transaction Series
+     * @param	  conn   Database connection
+     * @return    Error code if not valid
+     * @exception ITMException
+     */
 	public String isAnalysis(String acctCode, String analCode, String refSer, Connection conn)
 	{
 //		 To check Analysis code in analysis table
@@ -2176,6 +2264,16 @@ public class FinCommon
 		return errCode;
 	}
 
+    /**
+     * Returns error code if loan party is not valid
+     *
+     * @param     siteCode  Site Code
+     * @param     loanCode  Loan party code
+     * @param     refSer  Transaction Series
+     * @param	  conn   Database connection
+     * @return    Error code if not valid
+     * @exception ITMException
+     */
 	public String isLoanParty(String siteCode,String loanCode,String refSer, Connection conn)
 	{
 //		 CHECKING WHETHER LOANPARTY HAS TO BE CHECKED IN SITE TABLE OR NOT
@@ -2240,6 +2338,16 @@ public class FinCommon
 		return errCode;
 
 	}
+    /**
+     * Returns error code if tax authority is not valid
+     *
+     * @param     siteCode  Site Code
+     * @param     tauthCode  Tax authority code
+     * @param     refSer  Transaction Series
+     * @param	  conn   Database connection
+     * @return    Error code if not valid
+     * @exception ITMException
+     */
 	public String isTaxAuth(String siteCode,String tauthCode,String refSer, Connection conn)
 	{
 //		CHECKING IN TAX AUTHORITY MASTER
@@ -2274,6 +2382,16 @@ public class FinCommon
 		}
 		return errCode;
 	}
+    /**
+     * Returns error code if supplier code is not valid
+     *
+     * @param     siteCode  Site Code
+     * @param     suppCode  Supplier code
+     * @param     refSer  Transaction Series
+     * @param	  conn   Database connection
+     * @return    Error code if not valid
+     * @exception ITMException
+     */
 	public String isSupplier(String siteCode,String suppCode,String refSer, Connection conn)
 	{
 		String errCode = "";
@@ -2379,6 +2497,16 @@ public class FinCommon
 		return errCode;
 	}
 
+    /**
+     * Returns error code if employee code is not valid
+     *
+     * @param     siteCode  Site Code
+     * @param     empCode  Employee code
+     * @param     refSer  Transaction Series
+     * @param	  conn   Database connection
+     * @return    Error code if not valid
+     * @exception ITMException
+     */
 	public String isEmployee(String siteCode,String empCode,String refSer, Connection conn)
 	{
 		PreparedStatement pstmt = null;
@@ -2433,6 +2561,16 @@ public class FinCommon
 		return errCode;
 	}
 
+    /**
+     * Returns error code if sales person code is not valid
+     *
+     * @param     siteCode  Site Code
+     * @param     spersCode  Sales person code
+     * @param     refSer  Transaction Series
+     * @param	  conn   Database connection
+     * @return    Error code if not valid
+     * @exception ITMException
+     */
 	public String isSalesPerson(String siteCode,String spersCode,String refSer, Connection conn)
 	{
 //		 CHECKING WHETHER SALES_PERSON HAS TO BE CHECKED IN SITE TABLE OR NOT
@@ -2522,6 +2660,16 @@ public class FinCommon
 		return errCode;
 	}
 
+    /**
+     * Returns error code if account type is not valid
+     *
+     * @param     acctCode  Account Code
+     * @param     sundryCode  Sundry code
+     * @param     sundryType  Sundry type
+     * @param	  conn   Database connection
+     * @return    Error code if not valid
+     * @exception ITMException
+     */
 	public String isAcctType(String acctCode, String sundryCode, String sundryType, Connection conn)
 	{
 		String errCode = null;
@@ -2606,6 +2754,15 @@ public class FinCommon
 		return errCode;
 	}
 
+    /**
+     * Returns error code if tax environment is not valid
+     *
+     * @param     taxEnv  Tax environment
+     * @param     date  Date on which validity is to be checked
+     * @param	  conn   Database connection
+     * @return    Error code if not valid
+     * @exception ITMException
+     */
 	public String checkTaxEnvStatus(String taxEnv, Timestamp date, Connection conn)
 	{
 		PreparedStatement pstmt = null;
@@ -2662,6 +2819,16 @@ public class FinCommon
 		return errCode;
 	}
 
+    /**
+     * Returns the cheque name of the suchdry code
+     *
+     * @param     sundryType  Sundry type
+     * @param     sundryCode  Sundry Code
+     * @param     cheque_or_name  Flag to indicate name or cheque name
+     * @param	  conn   Database connection
+     * @return    Name or cheque name
+     * @exception ITMException
+     */
 	public String getChequeName(String sundryType, String sundryCode, String cheque_or_name, Connection conn)
 	{
 		String sName = null, chqName = null, fName = null, mName = null, lName = null;
@@ -2957,6 +3124,16 @@ public class FinCommon
 		return chqName;
 	}
 
+    /**
+     * Returns the Account code and cost center code
+     *
+     * @param     itemCode  Item code
+     * @param     itemSer  Item series
+     * @param     purpose  Purpose of the account such as Sale, Purchase, Inventory, etc.
+     * @param	  conn   Database connection
+     * @return    Account as well as cost center code
+     * @exception ITMException
+     */
 	public String getFromAcctDetr(String itemCode, String itemSer, String purpose, Connection conn) throws ITMException
 	{
 		String acctCode = null, cctrCode = null, stkOpt = null, itemSerN = null;
@@ -4867,6 +5044,17 @@ public class FinCommon
 		return acctCode + "," + cctrCode;
 	}
 
+    /**
+     * Returns the Account code and cost center code
+     *
+     * @param     itemCode  Item code
+     * @param     itemSer  Item series
+     * @param     purpose  Purpose of the account such as Sale, Purchase, Inventory, etc.
+     * @param     tranType  Transaction type
+     * @param	  conn   Database connection
+     * @return    Account as well as cost center code
+     * @exception ITMException
+     */
 	public String getAcctDetrTtype(String itemCode, String itemSer, String purpose, String tranType, Connection conn) throws ITMException
 	{
 		String acctCode = null, cctrCode = null, stkOpt = null, itemSerN = null;
@@ -8142,12 +8330,29 @@ public class FinCommon
 		return acctCode + "," + cctrCode;
 	}
 	/////////////
+    /**
+     * Returns error code if update fails
+     *
+     * @param     glTrace  HashMap with account details
+     * @param	  conn   Database connection
+     * @return    Error code if fails
+     * @exception ITMException
+     */
 	public String glTraceUpdate(HashMap glTrace,Connection conn) throws ITMException//Added by Jiten 16/04/07
     {
 		String errString = glTraceUpdate( glTrace, conn,false);//change by vishakha for F14ISUN006 07-APR-15
 		 return errString;
     }
 	
+	  /**
+     * Returns error code if update fails
+     *
+     * @param     glTrace  HashMap with account details
+     * @param	  conn   Database connection
+     * @param	  isPreview   boolean Preview only 
+     * @return    Error code if fails
+     * @exception ITMException
+     */
 	public String glTraceUpdate(HashMap glTrace,Connection conn,boolean isPreview) throws ITMException//Added by Jiten 16/04/07
     {
 		System.out.println("inside gltraceupdate");
@@ -8657,6 +8862,15 @@ public class FinCommon
 	
 	
 	    //nvo_business_object_fin - gbf_get_project()
+    /**
+     * Returns Project code from specified transaction
+     *
+     * @param     refSer  Transaction series
+	 * @param     refId   Transaction Id
+     * @param	  conn   Database connection
+     * @return    Project code
+     * @exception ITMException
+     */
     public String getProject(String refSer,String refId,Connection conn) throws ITMException//Added by Jiten
     {
         Statement stmt = null;
@@ -8725,6 +8939,14 @@ public class FinCommon
         return entryBatchNo;
     }
 	    //nvo_business_object_fin - gbf_gltran_upd()
+    /**
+     * Returns updates gltran table
+     *
+     * @param     glTran  Hashap with account details
+     * @param	  conn   Database connection
+     * @return    Error code if fails
+     * @exception ITMException
+     */
     public String glTranUpdate(HashMap glTran,Connection conn) throws ITMException // added by Jiten
     {
         PreparedStatement pstmt = null;
@@ -9062,6 +9284,16 @@ public class FinCommon
         return errString;
     }
 	    //nvo_business_object_budget - gbf_gltrace_update_budget
+    /**
+     * Returns Error code if fails
+     *
+     * @param     tranId  Transaction Id
+     * @param     refId  Reference Id
+     * @param     refSer  Reference series
+     * @param	  conn   Database connection
+     * @return    Error code if fails
+     * @exception ITMException
+     */
     public String glTraceUpdatebudget(String tranId,String refId,String refSer,Connection conn) throws ITMException // Added by Jiten
     {
         Statement stmt = null,stmt1 = null;
@@ -9159,6 +9391,15 @@ public class FinCommon
         return errString;
     }
 	    //nvo_business_object_budget - gbf_update_budget
+    /**
+     * Updates budget amount
+     *
+     * @param     budgetXmlString  XML budget data
+     * @param     warning  Flag indicating whether warning to displayed
+     * @param	  conn   Database connection
+     * @return    Error code if fails
+     * @exception ITMException
+     */
     public String updateBudget(String budgetXmlString,String warning,Connection conn) throws ITMException// Added by Jiten
     {
         PreparedStatement pstmt= null;
@@ -9584,6 +9825,15 @@ public class FinCommon
         return errString;
     }
 	    //nvo_business_object_fin - gbf_check_gltran_drcr()
+    /**
+     * Compare whether gltrace debit and credit are matching
+     *
+     * @param     refSer  Reference series
+     * @param     refId  Reference Id
+     * @param	  conn   Database connection
+     * @return    Error code if fails
+     * @exception ITMException
+     */
     public String checkGlTranDrCr(String refSer,String refId,Connection conn) throws ITMException //Added by Jiten
     {
         Statement stmt = null;
@@ -9885,6 +10135,15 @@ public class FinCommon
     }
 
 	// Following methods are added as required in Pheno Project Customization - Piyush - 25/03/08
+    /**
+     * Updates bank transaction log
+     *
+     * @param     hMapBankTranLog  HashMap with bank transaction details
+     * @param     xtraParams  Extra parameters
+     * @param	  conn   Database connection
+     * @return    Error code if fails
+     * @exception ITMException
+     */
 	public String bankTranLogUpdate(HashMap hMapBankTranLog, String xtraParams , Connection conn) throws ITMException
 	{
 		String errString = "";
@@ -10101,6 +10360,19 @@ public class FinCommon
 
 
 	// End addition of new methods for Pheno Project customization - Piyush - 25/03/08
+    /**
+     * Gets the account and cost center code for distribution from site to site
+     *
+     * @param     siteCodeFrom  Site code from
+     * @param     siteCodeTo  Site code to
+     * @param     grpCode  Site code to
+     * @param     itemCode  Item code
+     * @param     purpose  Purpose
+     * @param     tranType  Transaction type
+     * @param	  conn   Database connection
+     * @return    Error code if fails
+     * @exception ITMException
+     */
 	public String getAcctDetrDistTtype(String siteCodeFrom,String siteCodeTo, String itemSer,String grpCode,String itemCode, String purpose, String tranType, Connection conn) throws ITMException
 	{
 		String acctCode = null, cctrCode = null;
@@ -10969,6 +11241,15 @@ public class FinCommon
 		return acctCode + "," + cctrCode;
 	}
 	//nvo_business_object_fin - gf_get_contactcode() - added by chandni - 1/07/11
+    /**
+     * Gets the contact code
+     *
+     * @param     sundryType  Sundry type
+     * @param     SundryCode  Sundry code
+     * @param	  conn   Database connection
+     * @return    Error code if fails
+     * @exception ITMException
+     */
 	public String getContactCode(String sundryType,String SundryCode,Connection conn) throws ITMException
 	{
 		PreparedStatement pstmt = null;
@@ -11057,6 +11338,15 @@ public class FinCommon
 		return contactCode;
 	}
 	//nvo_business_object_fin - gf_get_party_doc_ref() - added by chandni - 23/08/11
+    /**
+     * Gets the Party document reference
+     *
+     * @param     refSer  reference series
+     * @param     refNo  Reference id
+     * @param	  conn   Database connection
+     * @return    Error code if fails
+     * @exception ITMException
+     */
 	public String gfGetPartyDocRef(String refSer,String refNo,Connection conn) throws ITMException
 	{
 		PreparedStatement pstmt = null;
@@ -11184,6 +11474,14 @@ public class FinCommon
 		return returns;
 	}//method end
 	//nvo_business_object_fin - gbf_miscpay_upd() - added by chandni - 23/08/11
+	/**
+     * Updates misc. payables
+     *
+     * @param     miscPayMap  HashMap with payables details
+     * @param	  conn   Database connection
+     * @return    Error code if fails
+     * @exception ITMException
+     */
 	public String gbfMiscPayUpd(HashMap miscPayMap,Connection conn) throws ITMException
 	{
 		PreparedStatement pstmt = null;
@@ -11366,6 +11664,14 @@ public class FinCommon
 	}//method end
 	
 	//gbf_receivables_upd() - added by chandni - 29/09/11
+	/**
+     * Updates receivables
+     *
+     * @param     receivablesMap  HashMap with receivables details
+     * @param	  conn   Database connection
+     * @return    Error code if fails
+     * @exception ITMException
+     */
 	public String gbfReceivablesUpd(HashMap receivablesMap,Connection conn)throws ITMException
 	{
 		PreparedStatement pstmt = null;
@@ -11577,7 +11883,17 @@ public class FinCommon
 		}
 		return errString;
 	}// end of method
-	public String nfCheckPeriod(String modCode, java.util.Date tranDate , String siteCode, Connection conn) throws RemoteException, ITMException
+	/**
+     * Check period validity for date passed
+     *
+     * @param     modCode  String module code, ADM - HR & Payroll, DIS - Distibution, FIN - Finance, MFG - Manufacturing 
+	 * @param 	tranDate  Timestamp  transaction date
+	 * @param	siteCode String site code
+     * @param	  conn   Database connection
+     * @return    Error code if fails
+     * @exception ITMException
+     */
+public String nfCheckPeriod(String modCode, java.util.Date tranDate , String siteCode, Connection conn) throws RemoteException, ITMException
 	{
 		//Connection con = null;
 		String errCode = ""; //$NON-NLS-1$