svn commit: r1126071 - in /ofbiz/trunk/applications/accounting/src/org/ofbiz/accounting: invoice/InvoiceWorker.java payment/BillingAccountWorker.java payment/PaymentGatewayServices.java payment/PaymentWorker.java thirdparty/valuelink/ValueLinkApi.java

[mrisaliti]

Author: mrisaliti
Date: Sun May 22 16:46:10 2011
New Revision: 1126071

URL: http://svn.apache.org/viewvc?rev=1126071&view=rev
Log:
Removed some javadoc warning into accounting component

Modified:
    ofbiz/trunk/applications/accounting/src/org/ofbiz/accounting/invoice/InvoiceWorker.java
    ofbiz/trunk/applications/accounting/src/org/ofbiz/accounting/payment/BillingAccountWorker.java
    ofbiz/trunk/applications/accounting/src/org/ofbiz/accounting/payment/PaymentGatewayServices.java
    ofbiz/trunk/applications/accounting/src/org/ofbiz/accounting/payment/PaymentWorker.java
    ofbiz/trunk/applications/accounting/src/org/ofbiz/accounting/thirdparty/valuelink/ValueLinkApi.java

Modified: ofbiz/trunk/applications/accounting/src/org/ofbiz/accounting/invoice/InvoiceWorker.java
URL: http://svn.apache.org/viewvc/ofbiz/trunk/applications/accounting/src/org/ofbiz/accounting/invoice/InvoiceWorker.java?rev=1126071&r1=1126070&r2=1126071&view=diff
==============================================================================
--- ofbiz/trunk/applications/accounting/src/org/ofbiz/accounting/invoice/InvoiceWorker.java (original)
+++ ofbiz/trunk/applications/accounting/src/org/ofbiz/accounting/invoice/InvoiceWorker.java Sun May 22 16:46:10 2011
@@ -58,9 +58,9 @@ public class InvoiceWorker {
 
     /**
      * Return the total amount of the invoice (including tax) using the the invoiceId as input.
-     * @param delegator
-     * @param invoiceId
-     * @return
+     * @param delegator the delegator
+     * @param invoiceId the invoice id
+     * @return Return the total amount of the invoice
      */
     public static BigDecimal getInvoiceTotal(Delegator delegator, String invoiceId) {
         return getInvoiceTotal(delegator, invoiceId, Boolean.TRUE);
@@ -69,11 +69,11 @@ public class InvoiceWorker {
     /**
      * Return the total amount of the invoice (including tax) using the the invoiceId as input.
      * with the ability to specify if the actual currency is required.
-     * @param delegator
-     * @param invoiceId
+     * @param delegator the delegator
+     * @param invoiceId the invoice Id
      * @param actualCurrency true: provide the actual currency of the invoice (could be different from the system currency)
      *                       false: if required convert the actual currency into the system currency.
-     * @return
+     * @return Return the total amount of the invoice
      */
     public static BigDecimal getInvoiceTotal(Delegator delegator, String invoiceId, Boolean actualCurrency) {
         if (delegator == null) {
@@ -96,7 +96,7 @@ public class InvoiceWorker {
 
     /**
      * Method to return the total amount of an invoice item i.e. quantity * amount
-     * @param invoice GenericValue object of the Invoice
+     * @param invoiceItem GenericValue object of the invoice item
      * @return the invoice total as BigDecimal
      */
     public static BigDecimal getInvoiceItemTotal(GenericValue invoiceItem) {
@@ -151,10 +151,10 @@ public class InvoiceWorker {
       *
       * Return the total amount of the invoice (including tax) using the the invoice GenericValue as input.
       * with the ability to specify if the actual currency is required.
-      * @param invoice
+      * @param invoice GenericValue object of the Invoice
       * @param actualCurrency true: provide the actual currency of the invoice (could be different from the system currency)
       *                       false: if required convert the actual currency into the system currency.
-      * @return
+      * @return Return the total amount of the invoice
       */
      public static BigDecimal getInvoiceTotal(GenericValue invoice, Boolean actualCurrency) {
         BigDecimal invoiceTotal = ZERO;
@@ -341,7 +341,9 @@ public class InvoiceWorker {
 
     /**
      * Method to return the total amount of an invoice which is not yet applied to a payment
-     * @param invoice GenericValue object of the Invoice
+     * @param delegator the delegator
+     * @param invoiceId the invoice id
+     * @param actualCurrency the currency
      * @return the invoice total as BigDecimal
      */
     public static BigDecimal getInvoiceNotApplied(Delegator delegator, String invoiceId, Boolean actualCurrency) {
@@ -359,9 +361,9 @@ public class InvoiceWorker {
     /**
      * Returns amount not applied (i.e., still outstanding) of an invoice at an asOfDate, based on Payment.effectiveDate <= asOfDateTime
      *
-     * @param invoice
-     * @param asOfDateTime
-     * @return
+     * @param invoice GenericValue object of the invoice
+     * @param asOfDateTime the date to use
+     * @return Returns amount not applied of the invoice
      */
     public static BigDecimal getInvoiceNotApplied(GenericValue invoice, Timestamp asOfDateTime) {
         return InvoiceWorker.getInvoiceTotal(invoice, Boolean.TRUE).subtract(getInvoiceApplied(invoice, asOfDateTime));
@@ -370,7 +372,8 @@ public class InvoiceWorker {
 
     /**
      * Method to return the total amount of an invoice which is applied to a payment
-     * @param invoice GenericValue object of the Invoice
+     * @param delegator the delegator
+     * @param invoiceId the invoice id
      * @return the invoice total as BigDecimal
      */
     public static BigDecimal getInvoiceApplied(Delegator delegator, String invoiceId) {
@@ -380,10 +383,10 @@ public class InvoiceWorker {
     /**
      * Returns amount applied to invoice before an asOfDateTime, based on Payment.effectiveDate <= asOfDateTime
      *
-     * @param delegator
-     * @param invoiceId
+     * @param delegator the delegator
+     * @param invoiceId the invoice id
      * @param asOfDateTime - a Timestamp
-     * @return
+     * @return returns amount applied to invoice before an asOfDateTime
      */
     public static BigDecimal getInvoiceApplied(Delegator delegator, String invoiceId, Timestamp asOfDateTime, Boolean actualCurrency) {
         if (delegator == null) {
@@ -419,7 +422,7 @@ public class InvoiceWorker {
     }
     /**
      * Method to return the total amount of an invoice which is applied to a payment
-     * @param invoice GenericValue object of the Invoice
+     * @param invoice GenericValue object of the invoice
      * @return the applied total as BigDecimal
      */
     public static BigDecimal getInvoiceApplied(GenericValue invoice) {
@@ -427,10 +430,10 @@ public class InvoiceWorker {
     }
 
     /**
-     * @param delegator
-     * @param invoiceId
-     * @param invoiceItemSeqId
-     * @return
+     * Return the amount applied to the invoice
+     * @param invoice GenericValue object of the invoice
+     * @param actualCurrency the currency of the invoice
+     * @return returns the amount applied to the invoice
      */
     public static BigDecimal getInvoiceApplied(GenericValue invoice, Boolean actualCurrency) {
         return getInvoiceApplied(invoice.getDelegator(), invoice.getString("invoiceId"), UtilDateTime.nowTimestamp(), actualCurrency);
@@ -440,7 +443,9 @@ public class InvoiceWorker {
     }
     /**
      * Method to return the amount of an invoiceItem which is applied to a payment
-     * @param invoice GenericValue object of the Invoice
+     * @param delegator the delegator
+     * @param invoiceId the invoice id
+     * @param invoiceItemSeqId the invoice item id
      * @return the invoice total as BigDecimal
      */
     public static BigDecimal getInvoiceItemApplied(Delegator delegator, String invoiceId, String invoiceItemSeqId) {
@@ -464,7 +469,7 @@ public class InvoiceWorker {
 
     /**
      * Method to return the total amount of an invoiceItem which is applied to a payment
-     * @param invoice GenericValue object of the Invoice
+     * @param invoiceItem GenericValue object of the invoice item
      * @return the applied total as BigDecimal
      */
     public static BigDecimal getInvoiceItemApplied(GenericValue invoiceItem) {
@@ -694,7 +699,7 @@ public class InvoiceWorker {
 
     /** Returns the invoice tax total for unattributed tax items, that is items which have no taxAuthPartyId value
      * @param invoice GenericValue object representing the invoice
-     * @return
+     * @return Returns the invoice tax total for unattributed tax items
      */
     public static BigDecimal getInvoiceUnattributedTaxTotal(GenericValue invoice) {
          List<GenericValue> invoiceTaxItems = null;

Modified: ofbiz/trunk/applications/accounting/src/org/ofbiz/accounting/payment/BillingAccountWorker.java
URL: http://svn.apache.org/viewvc/ofbiz/trunk/applications/accounting/src/org/ofbiz/accounting/payment/BillingAccountWorker.java?rev=1126071&r1=1126070&r2=1126071&view=diff
==============================================================================
--- ofbiz/trunk/applications/accounting/src/org/ofbiz/accounting/payment/BillingAccountWorker.java (original)
+++ ofbiz/trunk/applications/accounting/src/org/ofbiz/accounting/payment/BillingAccountWorker.java Sun May 22 16:46:10 2011
@@ -128,9 +128,9 @@ public class BillingAccountWorker {
      * Calculates the "available" balance of a billing account, which is the
      * net balance minus amount of pending (not cancelled, rejected, or received) order payments.
      * When looking at using a billing account for a new order, you should use this method.
-     * @param billingAccountId
-     * @param delegator
-     * @return
+     * @param billingAccountId the billing account id
+     * @param delegator the delegato
+     * @return return the "available" balance of a billing account
      * @throws GenericEntityException
      */
     public static BigDecimal getBillingAccountBalance(Delegator delegator, String billingAccountId) throws GenericEntityException {
@@ -221,8 +221,8 @@ public class BillingAccountWorker {
     /**
      * Returns the amount which could be charged to a billing account, which is defined as the accountLimit minus account balance and minus the balance of outstanding orders
      * When trying to figure out how much of a billing account can be used to pay for an outstanding order, use this method
-     * @param billingAccount
-     * @return
+     * @param billingAccount GenericValue object of the billing account
+     * @return returns the amount which could be charged to a billing account
      * @throws GenericEntityException
      */
     public static BigDecimal getBillingAccountAvailableBalance(GenericValue billingAccount) throws GenericEntityException {
@@ -244,9 +244,9 @@ public class BillingAccountWorker {
     /**
      * Calculates the net balance of a billing account, which is sum of all amounts applied to invoices minus sum of all amounts applied from payments.
      * When charging or capturing an invoice to a billing account, use this method
-     * @param delegator
-     * @param billingAccountId
-     * @return
+     * @param delegator the delegator
+     * @param billingAccountId the billing account id
+     * @return the amount of the billing account which could be captured
      * @throws GenericEntityException
      */
     public static BigDecimal getBillingAccountNetBalance(Delegator delegator, String billingAccountId) throws GenericEntityException {
@@ -274,9 +274,9 @@ public class BillingAccountWorker {
 
     /**
      * Returns the amount of the billing account which could be captured, which is BillingAccount.accountLimit - net balance
-     * @param billingAccount
-     * @return
-     * @throws GenericEntityException
+     * @param billingAccount GenericValue object of the billing account
+     * @return the amount of the billing account which could be captured
+     * @throws GenericEntityException
      */
     public static BigDecimal availableToCapture(GenericValue billingAccount) throws GenericEntityException {
         BigDecimal netBalance = getBillingAccountNetBalance(billingAccount.getDelegator(), billingAccount.getString("billingAccountId"));

Modified: ofbiz/trunk/applications/accounting/src/org/ofbiz/accounting/payment/PaymentGatewayServices.java
URL: http://svn.apache.org/viewvc/ofbiz/trunk/applications/accounting/src/org/ofbiz/accounting/payment/PaymentGatewayServices.java?rev=1126071&r1=1126070&r2=1126071&view=diff
==============================================================================
--- ofbiz/trunk/applications/accounting/src/org/ofbiz/accounting/payment/PaymentGatewayServices.java (original)
+++ ofbiz/trunk/applications/accounting/src/org/ofbiz/accounting/payment/PaymentGatewayServices.java Sun May 22 16:46:10 2011
@@ -2811,8 +2811,8 @@ public class PaymentGatewayServices {
     /**
      * Gets the chronologically latest PaymentGatewayResponse from an OrderPaymentPreference which is either a PRDS_PAY_AUTH
      * or PRDS_PAY_REAUTH.  Used for capturing.
-     * @param orderPaymentPreference
-     * @return
+     * @param orderPaymentPreference GenericValue object of the order payment preference
+     * @return return the first authorization of the order payment preference
      */
     public static GenericValue getAuthTransaction(GenericValue orderPaymentPreference) {
         return EntityUtil.getFirst(getAuthTransactions(orderPaymentPreference));
@@ -2821,8 +2821,8 @@ public class PaymentGatewayServices {
     /**
      * Gets a chronologically ordered list of PaymentGatewayResponses from an OrderPaymentPreference which is either a PRDS_PAY_AUTH
      * or PRDS_PAY_REAUTH.
-     * @param orderPaymentPreference
-     * @return
+     * @param orderPaymentPreference GenericValue object of the order payment preference
+     * @return return the authorizations of the order payment preference
      */
     public static List<GenericValue> getAuthTransactions(GenericValue orderPaymentPreference) {
         List<GenericValue> authTransactions = null;

Modified: ofbiz/trunk/applications/accounting/src/org/ofbiz/accounting/payment/PaymentWorker.java
URL: http://svn.apache.org/viewvc/ofbiz/trunk/applications/accounting/src/org/ofbiz/accounting/payment/PaymentWorker.java?rev=1126071&r1=1126070&r2=1126071&view=diff
==============================================================================
--- ofbiz/trunk/applications/accounting/src/org/ofbiz/accounting/payment/PaymentWorker.java (original)
+++ ofbiz/trunk/applications/accounting/src/org/ofbiz/accounting/payment/PaymentWorker.java Sun May 22 16:46:10 2011
@@ -201,7 +201,8 @@ public class PaymentWorker {
 
     /**
      * Method to return the total amount of an payment which is applied to a payment
-     * @param payment GenericValue object of the Payment
+     * @param delegator the delegator
+     * @param paymentId paymentId of the Payment
      * @return the applied total as BigDecimal
      */
     public static BigDecimal getPaymentApplied(Delegator delegator, String paymentId) {
@@ -228,8 +229,8 @@ public class PaymentWorker {
     }
     /**
      * Method to return the amount applied converted to the currency of payment
-     * @param String paymentApplicationId
-     * @return the applied amount as BigDecimal
+     * @param paymentApplicationId the payment application id
+     * @return appliedAmount the applied amount as BigDecimal
      */
     public static BigDecimal getPaymentAppliedAmount(Delegator delegator, String paymentApplicationId) {
         GenericValue paymentApplication = null;
@@ -264,7 +265,7 @@ public class PaymentWorker {
     /**
      * Method to return the total amount of an payment which is applied to a payment
      * @param payment GenericValue object of the Payment
-     * @param false for currency of the payment, true for the actual currency
+     * @param actual false for currency of the payment, true for the actual currency
      * @return the applied total as BigDecimal in the currency of the payment
      */
     public static BigDecimal getPaymentApplied(GenericValue payment, Boolean actual) {

Modified: ofbiz/trunk/applications/accounting/src/org/ofbiz/accounting/thirdparty/valuelink/ValueLinkApi.java
URL: http://svn.apache.org/viewvc/ofbiz/trunk/applications/accounting/src/org/ofbiz/accounting/thirdparty/valuelink/ValueLinkApi.java?rev=1126071&r1=1126070&r2=1126071&view=diff
==============================================================================
--- ofbiz/trunk/applications/accounting/src/org/ofbiz/accounting/thirdparty/valuelink/ValueLinkApi.java (original)
+++ ofbiz/trunk/applications/accounting/src/org/ofbiz/accounting/thirdparty/valuelink/ValueLinkApi.java Sun May 22 16:46:10 2011
@@ -141,7 +141,7 @@ public class ValueLinkApi {
      * Obtain an instance of the ValueLinkApi; this method will always return an existing reference if one is available
      * @param delegator Delegator used to query the encryption keys
      * @param props Properties to use for the Api (usually payment.properties)
-     * @return
+     * @return Obtain an instance of the ValueLinkApi
      */
     public static ValueLinkApi getInstance(Delegator delegator, Properties props) {
         return getInstance(delegator, props, false);