svn commit: r1126704 - in /ofbiz/trunk/applications: manufacturing/src/org/ofbiz/ma
Locked
svn commit: r1126704 - in /ofbiz/trunk/applications: manufacturing/src/org/ofbiz/ma
 
|
Author: mrisaliti
Date: Mon May 23 20:04:02 2011 New Revision: 1126704 URL: http://svn.apache.org/viewvc?rev=1126704&view=rev Log: Removed some javadoc warning (wrong param/return) into application components no functional changes Modified: ofbiz/trunk/applications/manufacturing/src/org/ofbiz/manufacturing/bom/BOMNode.java ofbiz/trunk/applications/manufacturing/src/org/ofbiz/manufacturing/bom/BOMServices.java ofbiz/trunk/applications/manufacturing/src/org/ofbiz/manufacturing/bom/BOMTree.java ofbiz/trunk/applications/manufacturing/src/org/ofbiz/manufacturing/jobshopmgt/ProductionRun.java ofbiz/trunk/applications/manufacturing/src/org/ofbiz/manufacturing/jobshopmgt/ProductionRunHelper.java ofbiz/trunk/applications/manufacturing/src/org/ofbiz/manufacturing/mrp/InventoryEventPlannedServices.java ofbiz/trunk/applications/manufacturing/src/org/ofbiz/manufacturing/mrp/MrpServices.java ofbiz/trunk/applications/manufacturing/src/org/ofbiz/manufacturing/techdata/TechDataServices.java ofbiz/trunk/applications/order/src/org/ofbiz/order/finaccount/FinAccountHelper.java ofbiz/trunk/applications/order/src/org/ofbiz/order/order/OrderReadHelper.java ofbiz/trunk/applications/order/src/org/ofbiz/order/order/OrderReturnServices.java ofbiz/trunk/applications/order/src/org/ofbiz/order/order/OrderServices.java ofbiz/trunk/applications/order/src/org/ofbiz/order/shoppingcart/ShoppingCart.java ofbiz/trunk/applications/order/src/org/ofbiz/order/shoppingcart/ShoppingCartItem.java ofbiz/trunk/applications/order/src/org/ofbiz/order/shoppinglist/ShoppingListServices.java ofbiz/trunk/applications/party/src/org/ofbiz/party/communication/CommunicationEventServices.java ofbiz/trunk/applications/party/src/org/ofbiz/party/contact/ContactMechWorker.java ofbiz/trunk/applications/party/src/org/ofbiz/party/party/PartyServices.java ofbiz/trunk/applications/party/src/org/ofbiz/party/party/PartyWorker.java ofbiz/trunk/applications/product/src/org/ofbiz/product/config/ProductConfigWorker.java ofbiz/trunk/applications/product/src/org/ofbiz/product/inventory/InventoryWorker.java ofbiz/trunk/applications/product/src/org/ofbiz/product/product/ProductSearchSession.java ofbiz/trunk/applications/product/src/org/ofbiz/product/product/ProductServices.java ofbiz/trunk/applications/product/src/org/ofbiz/product/product/ProductWorker.java ofbiz/trunk/applications/product/src/org/ofbiz/product/spreadsheetimport/ImportProductServices.java ofbiz/trunk/applications/product/src/org/ofbiz/shipment/packing/PackingServices.java ofbiz/trunk/applications/workeffort/src/org/ofbiz/workeffort/workeffort/ICalWorker.java ofbiz/trunk/applications/workeffort/src/org/ofbiz/workeffort/workeffort/WorkEffortServices.java Modified: ofbiz/trunk/applications/manufacturing/src/org/ofbiz/manufacturing/bom/BOMNode.java URL: http://svn.apache.org/viewvc/ofbiz/trunk/applications/manufacturing/src/org/ofbiz/manufacturing/bom/BOMNode.java?rev=1126704&r1=1126703&r2=1126704&view=diff ============================================================================== --- ofbiz/trunk/applications/manufacturing/src/org/ofbiz/manufacturing/bom/BOMNode.java (original) +++ ofbiz/trunk/applications/manufacturing/src/org/ofbiz/manufacturing/bom/BOMNode.java Mon May 23 20:04:02 2011 @@ -649,7 +649,7 @@ public class BOMNode { /** * A part is considered manufactured if it has child nodes AND unless ignoreSupplierProducts is set, if it also has no unexpired SupplierProducts defined * @param ignoreSupplierProducts - * @return + * @return return if a part is considered manufactured */ public boolean isManufactured(boolean ignoreSupplierProducts) { List<GenericValue> supplierProducts = null; @@ -664,7 +664,7 @@ public class BOMNode { /** * By default, a part is manufactured if it has child nodes and it has NO SupplierProducts defined - * @return + * @return return if a part is manufactured */ public boolean isManufactured() { return isManufactured(false); Modified: ofbiz/trunk/applications/manufacturing/src/org/ofbiz/manufacturing/bom/BOMServices.java URL: http://svn.apache.org/viewvc/ofbiz/trunk/applications/manufacturing/src/org/ofbiz/manufacturing/bom/BOMServices.java?rev=1126704&r1=1126703&r2=1126704&view=diff ============================================================================== --- ofbiz/trunk/applications/manufacturing/src/org/ofbiz/manufacturing/bom/BOMServices.java (original) +++ ofbiz/trunk/applications/manufacturing/src/org/ofbiz/manufacturing/bom/BOMServices.java Mon May 23 20:04:02 2011 @@ -58,9 +58,9 @@ public class BOMServices { * in which the productId can be found in any of the * bills of materials of bomType type. * If the bomType input field is not passed then the depth is searched for all the bom types and the lowest depth is returned. - * @param dctx - * @param context - * @return + * @param dctx the dispatch context + * @param context the context + * @return returns the product's low level code (llc) i.e. the maximum depth */ public static Map<String, Object> getMaxDepth(DispatchContext dctx, Map<String, ? extends Object> context) { Map<String, Object> result = FastMap.newInstance(); @@ -118,10 +118,10 @@ public class BOMServices { * Given a product id, computes and updates the product's low level code (field billOfMaterialLevel in Product entity). * It also updates the llc of all the product's descendants. * For the llc only the manufacturing bom ("MANUF_COMPONENT") is considered. - * @param dctx - * @param context - * @return - */ + * @param dctx the distach context + * @param context the context + * @return the results of the updates the product's low level code + */ public static Map<String, Object> updateLowLevelCode(DispatchContext dctx, Map<String, ? extends Object> context) { Map<String, Object> result = FastMap.newInstance(); Delegator delegator = dctx.getDelegator(); @@ -207,10 +207,10 @@ public class BOMServices { /** Updates the product's low level code (llc) for all the products in the Product entity. * For the llc only the manufacturing bom ("MANUF_COMPONENT") is considered. - * @param dctx - * @param context - * @return - */ + * @param dctx the distach context + * @param context the context + * @return the results of the updates the product's low level code + */ public static Map<String, Object> initLowLevelCode(DispatchContext dctx, Map<String, ? extends Object> context) { Map<String, Object> result = FastMap.newInstance(); Delegator delegator = dctx.getDelegator(); @@ -252,9 +252,9 @@ public class BOMServices { * ancestor if present, null otherwise. * Useful to avoid loops when adding new assocs (components) * to a bill of materials. - * @param dctx - * @param context - * @return + * @param dctx the distach context + * @param context the context + * @return returns the ProductAssoc generic value for a duplicate productIdKey ancestor if present */ public static Map<String, Object> searchDuplicatedAncestor(DispatchContext dctx, Map<String, ? extends Object> context) { Map<String, Object> result = FastMap.newInstance(); @@ -285,9 +285,9 @@ public class BOMServices { * and {@link BOMNode}) that represents a * configured bill of material tree. * Useful for tree traversal (breakdown, explosion, implosion). - * @param dctx - * @param context - * @return + * @param dctx the distach context + * @param context the context + * @return return the bill of material tree */ public static Map<String, Object> getBOMTree(DispatchContext dctx, Map<String, ? extends Object> context) { Map<String, Object> result = FastMap.newInstance(); @@ -336,9 +336,9 @@ public class BOMServices { /** It reads the product's bill of materials, * if necessary configures it, and it returns its (possibly configured) components in * a List of {@link BOMNode}). - * @param dctx - * @param context - * @return + * @param dctx the distach context + * @param context the context + * @return return the list of manufacturing components */ public static Map<String, Object> getManufacturingComponents(DispatchContext dctx, Map<String, ? extends Object> context) { Map<String, Object> result = FastMap.newInstance(); @@ -742,9 +742,9 @@ public class BOMServices { /** It reads the product's bill of materials, * if necessary configures it, and it returns its (possibly configured) components in * a List of {@link BOMNode}). - * @param dctx - * @param context - * @return + * @param dctx the distach context + * @param context the context + * @return returns the list of products in packages */ public static Map<String, Object> getProductsInPackages(DispatchContext dctx, Map<String, ? extends Object> context) { Map<String, Object> result = FastMap.newInstance(); Modified: ofbiz/trunk/applications/manufacturing/src/org/ofbiz/manufacturing/bom/BOMTree.java URL: http://svn.apache.org/viewvc/ofbiz/trunk/applications/manufacturing/src/org/ofbiz/manufacturing/bom/BOMTree.java?rev=1126704&r1=1126703&r2=1126704&view=diff ============================================================================== --- ofbiz/trunk/applications/manufacturing/src/org/ofbiz/manufacturing/bom/BOMTree.java (original) +++ ofbiz/trunk/applications/manufacturing/src/org/ofbiz/manufacturing/bom/BOMTree.java Mon May 23 20:04:02 2011 @@ -316,9 +316,17 @@ public class BOMTree { /** It visits the in-memory tree that represents a bill of materials * and it creates a manufacturing order for each of the nodes that needs * to be manufactured. - * @param orderId The (sales) order id for which the manufacturing orders are created. If specified (together with orderItemSeqId) a link between the two order lines is created. If null, no link is created. - * @param orderItemSeqId - * @param delegator The delegator used. + * @param facilityId the facility id + * @param date the context date + * @param workEffortName the work effort name + * @param description the description + * @param routingId the routing id + * @param orderId the order id + * @param orderItemSeqId the order item id + * @param shipGroupSeqId the shipment group item id + * @param shipmentId the shipment id delegator used + * @param userLogin the GenericValue object of userLogin + * @return returns the work effort id * @throws GenericEntityException If a db problem occurs. */ public String createManufacturingOrders(String facilityId, Date date, String workEffortName, String description, String routingId, String orderId, String orderItemSeqId, String shipGroupSeqId, String shipmentId, GenericValue userLogin) throws GenericEntityException { Modified: ofbiz/trunk/applications/manufacturing/src/org/ofbiz/manufacturing/jobshopmgt/ProductionRun.java URL: http://svn.apache.org/viewvc/ofbiz/trunk/applications/manufacturing/src/org/ofbiz/manufacturing/jobshopmgt/ProductionRun.java?rev=1126704&r1=1126703&r2=1126704&view=diff ============================================================================== --- ofbiz/trunk/applications/manufacturing/src/org/ofbiz/manufacturing/jobshopmgt/ProductionRun.java (original) +++ ofbiz/trunk/applications/manufacturing/src/org/ofbiz/manufacturing/jobshopmgt/ProductionRun.java Mon May 23 20:04:02 2011 @@ -192,7 +192,7 @@ public class ProductionRun { } /** * set the quantity property and recalculated the productComponent quantity. - * @return + * @param newQuantity the new quantity to be set **/ public void setQuantity(BigDecimal newQuantity) { if (quantity == null) getProductProduced(); @@ -216,7 +216,7 @@ public class ProductionRun { } /** * set the estimatedStartDate property. - * @return + * @param estimatedStartDate set the estimatedStartDate property **/ public void setEstimatedStartDate(Timestamp estimatedStartDate) { this.estimatedStartDate = estimatedStartDate; @@ -238,7 +238,7 @@ public class ProductionRun { /** * set the estimatedCompletionDate property without any control or calculation. * usage productionRun.setEstimatedCompletionDate(productionRun.recalculateEstimatedCompletionDate(priority); - * @return + * @param estimatedCompletionDate set the estimatedCompletionDate property **/ public void setEstimatedCompletionDate(Timestamp estimatedCompletionDate) { this.estimatedCompletionDate = estimatedCompletionDate; @@ -383,7 +383,6 @@ public class ProductionRun { /** * clear list of all the productionRunRoutingTasks to force re-reading at the next need. * This methode is used when the routingTasks ordering is changed. - * @return **/ public void clearRoutingTasksList() { this.productionRunRoutingTasks = null; Modified: ofbiz/trunk/applications/manufacturing/src/org/ofbiz/manufacturing/jobshopmgt/ProductionRunHelper.java URL: http://svn.apache.org/viewvc/ofbiz/trunk/applications/manufacturing/src/org/ofbiz/manufacturing/jobshopmgt/ProductionRunHelper.java?rev=1126704&r1=1126703&r2=1126704&view=diff ============================================================================== --- ofbiz/trunk/applications/manufacturing/src/org/ofbiz/manufacturing/jobshopmgt/ProductionRunHelper.java (original) +++ ofbiz/trunk/applications/manufacturing/src/org/ofbiz/manufacturing/jobshopmgt/ProductionRunHelper.java Mon May 23 20:04:02 2011 @@ -46,8 +46,8 @@ public class ProductionRunHelper { /** * Get a Production Run. * <li> check if routing - product link exist - * @param ctx The DispatchContext that this service is operating in. - * @param context Map containing the input parameters, productionRunId + * @param delegator the delegator + * @param productionRunId the production run id * @return Map with the result of the service, the output parameters are * <li> the productionRun * <li> the productionRunProduct Modified: ofbiz/trunk/applications/manufacturing/src/org/ofbiz/manufacturing/mrp/InventoryEventPlannedServices.java URL: http://svn.apache.org/viewvc/ofbiz/trunk/applications/manufacturing/src/org/ofbiz/manufacturing/mrp/InventoryEventPlannedServices.java?rev=1126704&r1=1126703&r2=1126704&view=diff ============================================================================== --- ofbiz/trunk/applications/manufacturing/src/org/ofbiz/manufacturing/mrp/InventoryEventPlannedServices.java (original) +++ ofbiz/trunk/applications/manufacturing/src/org/ofbiz/manufacturing/mrp/InventoryEventPlannedServices.java Mon May 23 20:04:02 2011 @@ -42,9 +42,9 @@ public class InventoryEventPlannedServic * Create an MrpEvent. * Make an update if a record exist with same key, (adding the event quantity to the exiting record) * - * @param ctx - * @param context: a map containing the parameters used to create an MrpEvent - * @return result: a map with service status + * @param ctx the dispatch context + * @param context a map containing the parameters used to create an MrpEvent + * @return result a map with service status */ public static Map<String, Object> createMrpEvent(DispatchContext ctx, Map<String, ? extends Object> context) { Delegator delegator = ctx.getDelegator(); Modified: ofbiz/trunk/applications/manufacturing/src/org/ofbiz/manufacturing/mrp/MrpServices.java URL: http://svn.apache.org/viewvc/ofbiz/trunk/applications/manufacturing/src/org/ofbiz/manufacturing/mrp/MrpServices.java?rev=1126704&r1=1126703&r2=1126704&view=diff ============================================================================== --- ofbiz/trunk/applications/manufacturing/src/org/ofbiz/manufacturing/mrp/MrpServices.java (original) +++ ofbiz/trunk/applications/manufacturing/src/org/ofbiz/manufacturing/mrp/MrpServices.java Mon May 23 20:04:02 2011 @@ -550,13 +550,13 @@ public class MrpServices { /** * Process the bill of material (bom) of the product to insert components in the MrpEvent table. - * Before inserting in the entity, test if there is the record already existing to add quantity rather to create a new one. - * - * @param product + * Before inserting in the entity, test if there is the record already existing to add quantity rather to create a new one. + * @param mrpId the mrp id + * @param product GenericValue oject of the product * @param eventQuantity the product quantity needed - * @param startDate the startDate of the productionRun which will used to produce the product - * @param routingTaskStartDate Map with all the routingTask as keys and startDate of each of them - * @return None + * @param startDate the startDate of the productionRun which will used to produce the product + * @param routingTaskStartDate Map with all the routingTask as keys and startDate of each of them + * @param listComponent a List with all the components */ public static void processBomComponent(String mrpId, GenericValue product, BigDecimal eventQuantity, Timestamp startDate, Map<String, Object> routingTaskStartDate, List<BOMNode> listComponent) { Modified: ofbiz/trunk/applications/manufacturing/src/org/ofbiz/manufacturing/techdata/TechDataServices.java URL: http://svn.apache.org/viewvc/ofbiz/trunk/applications/manufacturing/src/org/ofbiz/manufacturing/techdata/TechDataServices.java?rev=1126704&r1=1126703&r2=1126704&view=diff ============================================================================== --- ofbiz/trunk/applications/manufacturing/src/org/ofbiz/manufacturing/techdata/TechDataServices.java (original) +++ ofbiz/trunk/applications/manufacturing/src/org/ofbiz/manufacturing/techdata/TechDataServices.java Mon May 23 20:04:02 2011 @@ -59,9 +59,9 @@ public class TechDataServices { * * Used to retrieve some RoutingTasks (WorkEffort) selected by Name or MachineGroup ordered by Name * - * @param ctx - * @param context: a map containing workEffortName (routingTaskName) and fixedAssetId (MachineGroup or ANY) - * @return result: a map containing lookupResult (list of RoutingTask <=> workEffortId with currentStatusId = "ROU_ACTIVE" and workEffortTypeId = "ROU_TASK" + * @param ctx the dispatch context + * @param context a map containing workEffortName (routingTaskName) and fixedAssetId (MachineGroup or ANY) + * @return result a map containing lookupResult (list of RoutingTask <=> workEffortId with currentStatusId = "ROU_ACTIVE" and workEffortTypeId = "ROU_TASK" */ public static Map<String, Object> lookupRoutingTask(DispatchContext ctx, Map<String, ? extends Object> context) { Delegator delegator = ctx.getDelegator(); Modified: ofbiz/trunk/applications/order/src/org/ofbiz/order/finaccount/FinAccountHelper.java URL: http://svn.apache.org/viewvc/ofbiz/trunk/applications/order/src/org/ofbiz/order/finaccount/FinAccountHelper.java?rev=1126704&r1=1126703&r2=1126704&view=diff ============================================================================== --- ofbiz/trunk/applications/order/src/org/ofbiz/order/finaccount/FinAccountHelper.java (original) +++ ofbiz/trunk/applications/order/src/org/ofbiz/order/finaccount/FinAccountHelper.java Mon May 23 20:04:02 2011 @@ -71,12 +71,12 @@ public class FinAccountHelper { /** * A convenience method which adds transactions.get(0).get(fieldName) to initialValue, all done in BigDecimal to decimals and rounding - * @param initialValue - * @param transactions - * @param fieldName - * @param decimals - * @param rounding - * @return + * @param initialValue the initial value + * @param transactions a List of GenericValue objects of transactions + * @param fieldName the field name to get the value from the transaction + * @param decimals number of decimals + * @param rounding how to rounding + * @return the new value in a BigDecimal field * @throws GenericEntityException */ public static BigDecimal addFirstEntryAmount(BigDecimal initialValue, List<GenericValue> transactions, String fieldName, int decimals, int rounding) throws GenericEntityException { @@ -96,8 +96,8 @@ public class FinAccountHelper { /** * Returns a unique randomly generated account code for FinAccount.finAccountCode composed of uppercase letters and numbers * @param codeLength length of code in number of characters - * @param delegator - * @return + * @param delegator the delegator + * @return returns a unique randomly generated account code for FinAccount.finAccountCode composed of uppercase letters and numbers * @throws GenericEntityException */ public static String getNewFinAccountCode(int codeLength, Delegator delegator) throws GenericEntityException { @@ -130,9 +130,9 @@ public class FinAccountHelper { /** * Gets the first (and should be only) FinAccount based on finAccountCode, which will be cleaned up to be only uppercase and alphanumeric - * @param finAccountCode - * @param delegator - * @return + * @param finAccountCode the financial account code + * @param delegator the delegator + * @return gets the first financial account by code * @throws GenericEntityException */ public static GenericValue getFinAccountFromCode(String finAccountCode, Delegator delegator) throws GenericEntityException { @@ -170,10 +170,10 @@ public class FinAccountHelper { /** * Sum of all DEPOSIT and ADJUSTMENT transactions minus all WITHDRAWAL transactions whose transactionDate is before asOfDateTime - * @param finAccountId - * @param asOfDateTime - * @param delegator - * @return + * @param finAccountId the financial account id + * @param asOfDateTime the validity date + * @param delegator the delegator + * @return returns the sum of all DEPOSIT and ADJUSTMENT transactions minus all WITHDRAWAL transactions * @throws GenericEntityException */ public static BigDecimal getBalance(String finAccountId, Timestamp asOfDateTime, Delegator delegator) throws GenericEntityException { @@ -209,10 +209,10 @@ public class FinAccountHelper { /** * Returns the net balance (see above) minus the sum of all authorization amounts which are not expired and were authorized by the as of date - * @param finAccountId - * @param asOfDateTime - * @param delegator - * @return + * @param finAccountId the financial account id + * @param asOfDateTime the validity date + * @param delegator the delegator + * @return returns the net balance (see above) minus the sum of all authorization amounts which are not expired * @throws GenericEntityException */ public static BigDecimal getAvailableBalance(String finAccountId, Timestamp asOfDateTime, Delegator delegator) throws GenericEntityException { @@ -241,9 +241,9 @@ public class FinAccountHelper { /** * Validates a FinAccount's PIN number - * @param delegator - * @param finAccountId - * @param pinNumber + * @param delegator the delegator + * @param finAccountId the financial account id + * @param pinNumber a pin number * @return true if the bin is valid */ public static boolean validatePin(Delegator delegator, String finAccountId, String pinNumber) { @@ -267,11 +267,11 @@ public class FinAccountHelper { } /** - * - * @param delegator + * Generate a random financial number + * @param delegator the delegator * @param length length of the number to generate (up to 19 digits) * @param isId to be used as an ID (will check the DB to make sure it doesn't already exist) - * @return String generated number + * @return Generated number * @throws GenericEntityException */ public static String generateRandomFinNumber(Delegator delegator, int length, boolean isId) throws GenericEntityException { Modified: ofbiz/trunk/applications/order/src/org/ofbiz/order/order/OrderReadHelper.java URL: http://svn.apache.org/viewvc/ofbiz/trunk/applications/order/src/org/ofbiz/order/order/OrderReadHelper.java?rev=1126704&r1=1126703&r2=1126704&view=diff ============================================================================== --- ofbiz/trunk/applications/order/src/org/ofbiz/order/order/OrderReadHelper.java (original) +++ ofbiz/trunk/applications/order/src/org/ofbiz/order/order/OrderReadHelper.java Mon May 23 20:04:02 2011 @@ -209,7 +209,7 @@ public class OrderReadHelper { /** * Returns a Map of paymentMethodId -> amount charged (BigDecimal) based on PaymentGatewayResponse. - * @return + * @return returns a Map of paymentMethodId -> amount charged (BigDecimal) based on PaymentGatewayResponse. */ public Map<String, BigDecimal> getReceivedPaymentTotalsByPaymentMethod() { Map<String, BigDecimal> paymentMethodAmounts = FastMap.newInstance(); @@ -258,7 +258,7 @@ public class OrderReadHelper { /** * Returns a Map of paymentMethodId -> amount refunded - * @return + * @return returns a Map of paymentMethodId -> amount refunded */ public Map<String, BigDecimal> getReturnedTotalsByPaymentMethod() { Map<String, BigDecimal> paymentMethodAmounts = FastMap.newInstance(); @@ -337,7 +337,8 @@ public class OrderReadHelper { } /** - * @return Long number of days from termDays of first FIN_PAYMENT_TERM + * Return the number of days from termDays of first FIN_PAYMENT_TERM + * @return number of days from termDays of first FIN_PAYMENT_TERM */ public Long getOrderTermNetDays() { List<GenericValue> orderTerms = EntityUtil.filterByAnd(getOrderTerms(), UtilMisc.toMap("termTypeId", "FIN_PAYMENT_TERM")); @@ -2797,7 +2798,7 @@ public class OrderReadHelper { /** * Get orderAdjustments that have no corresponding returnAdjustment - * @return orderAdjustmentList + * @return return the order adjustments that have no corresponding with return adjustment */ public List<GenericValue> getAvailableOrderHeaderAdjustments() { List<GenericValue> orderHeaderAdjustments = this.getOrderHeaderAdjustments(); @@ -2822,9 +2823,9 @@ public class OrderReadHelper { /** * Get the total return adjustments for a set of key -> value condition pairs. Done for code efficiency. - * @param delegator - * @param condition - * @return + * @param delegator the delegator + * @param condition a map of the conditions to use + * @return Get the total return adjustments */ public static BigDecimal getReturnAdjustmentTotal(Delegator delegator, Map<String, Object> condition) { BigDecimal total = ZERO; Modified: ofbiz/trunk/applications/order/src/org/ofbiz/order/order/OrderReturnServices.java URL: http://svn.apache.org/viewvc/ofbiz/trunk/applications/order/src/org/ofbiz/order/order/OrderReturnServices.java?rev=1126704&r1=1126703&r2=1126704&view=diff ============================================================================== --- ofbiz/trunk/applications/order/src/org/ofbiz/order/order/OrderReturnServices.java (original) +++ ofbiz/trunk/applications/order/src/org/ofbiz/order/order/OrderReturnServices.java Mon May 23 20:04:02 2011 @@ -1016,9 +1016,9 @@ public class OrderReturnServices { /** * Helper method to get billing account balance, cannot use BillingAccountWorker.getBillingAccountBalance() * due to circular build dependency. - * @param billingAccountId - * @param dctx - * @return + * @param billingAccountId the billing account id + * @param dctx the dispatch context + * @return returns the billing account balance * @throws GenericEntityException */ public static BigDecimal getBillingAccountBalance(String billingAccountId, DispatchContext dctx) throws GenericEntityException { @@ -2273,11 +2273,12 @@ public class OrderReturnServices { /** * Takes a List of returnItems and returns a Map of orderId -> items and a Map of orderId -> orderTotal - * @param returnItems - * @param itemsByOrder - * @param totalByOrder - * @param delegator - * @param returnId + * @param returnItems a List of return items + * @param returnItemsByOrderId the return items by order id + * @param totalByOrder the total by order id + * @param delegator the delegator + * @param returnId the return id + * @param returnTypeId the return type id */ public static void groupReturnItemsByOrder(List<GenericValue> returnItems, Map<String, List<GenericValue>> returnItemsByOrderId, Map<String, BigDecimal> totalByOrder, Delegator delegator, String returnId, String returnTypeId) { Iterator<GenericValue> itemIt = returnItems.iterator(); @@ -2638,8 +2639,8 @@ public class OrderReturnServices { /** * These return adjustment types need to be recalculated when the return item is updated - * @param returnAdjustmentTypeId - * @return + * @param returnAdjustmentTypeId the return adjustment type id + * @return returns if the returnn adjustment need to be recalculated */ public static boolean needRecalculate(String returnAdjustmentTypeId) { return "RET_PROMOTION_ADJ".equals(returnAdjustmentTypeId) || @@ -2650,9 +2651,9 @@ public class OrderReturnServices { /** * Get the total return adjustments for a set of key -> value condition pairs. Done for code efficiency. - * @param delegator - * @param condition - * @return + * @param delegator the delegator + * @param condition the conditions to use + * @return return the total return adjustments */ public static BigDecimal getReturnAdjustmentTotal(Delegator delegator, Map<String, ? extends Object> condition) { BigDecimal total = BigDecimal.ZERO; @@ -2678,7 +2679,7 @@ public class OrderReturnServices { /** * Get rid of unnecessary parameters based on the given service name * @param dctx Service DispatchContext - * @param serviceName + * @param serviceName the service name * @param context context before clean up * @return filtered context * @throws GenericServiceException Modified: ofbiz/trunk/applications/order/src/org/ofbiz/order/order/OrderServices.java URL: http://svn.apache.org/viewvc/ofbiz/trunk/applications/order/src/org/ofbiz/order/order/OrderServices.java?rev=1126704&r1=1126703&r2=1126704&view=diff ============================================================================== --- ofbiz/trunk/applications/order/src/org/ofbiz/order/order/OrderServices.java (original) +++ ofbiz/trunk/applications/order/src/org/ofbiz/order/order/OrderServices.java Mon May 23 20:04:02 2011 @@ -4901,9 +4901,9 @@ public class OrderServices { /** * Generates a product requirement for the total cancelled quantity over all order items for each product - * @param dctx - * @param context - * @return + * @param dctx the dispatch context + * @param context the context + * @return the result of the service execution */ public static Map<String, Object> generateReqsFromCancelledPOItems(DispatchContext dctx, Map<String, ? extends Object> context) { Delegator delegator = dctx.getDelegator(); @@ -4978,9 +4978,9 @@ public class OrderServices { /** * Cancels remaining (unreceived) quantities for items of an order. Does not consider received-but-rejected quantities. - * @param dctx - * @param context - * @return + * @param dctx the dispatch context + * @param context the context + * @return cancels remaining (unreceived) quantities for items of an order */ public static Map<String, Object> cancelRemainingPurchaseOrderItems(DispatchContext dctx, Map<String, ? extends Object> context) { Delegator delegator = dctx.getDelegator(); Modified: ofbiz/trunk/applications/order/src/org/ofbiz/order/shoppingcart/ShoppingCart.java URL: http://svn.apache.org/viewvc/ofbiz/trunk/applications/order/src/org/ofbiz/order/shoppingcart/ShoppingCart.java?rev=1126704&r1=1126703&r2=1126704&view=diff ============================================================================== --- ofbiz/trunk/applications/order/src/org/ofbiz/order/shoppingcart/ShoppingCart.java (original) +++ ofbiz/trunk/applications/order/src/org/ofbiz/order/shoppingcart/ShoppingCart.java Mon May 23 20:04:02 2011 @@ -1130,8 +1130,8 @@ public class ShoppingCart implements Ite /** * Get ship before date for a particular ship group - * @param idx - * @return + * @param idx the ship group number + * @return ship before date for a given ship group */ public Timestamp getShipBeforeDate(int idx) { CartShipInfo csi = this.getShipInfo(idx); @@ -1140,7 +1140,7 @@ public class ShoppingCart implements Ite /** * Get ship before date for ship group 0 - * @return + * @return ship before date for the first ship group */ public Timestamp getShipBeforeDate() { return this.getShipBeforeDate(0); @@ -1148,8 +1148,8 @@ public class ShoppingCart implements Ite /** * Set ship after date for a particular ship group - * @param idx - * @param shipAfterDate + * @param idx the ship group number + * @param shipAfterDate the ship after date to be set for the given ship group */ public void setShipAfterDate(int idx, Timestamp shipAfterDate) { CartShipInfo csi = this.getShipInfo(idx); @@ -1158,7 +1158,7 @@ public class ShoppingCart implements Ite /** * Set ship after date for a particular ship group - * @param shipAfterDate + * @param shipAfterDate the ship after date to be set for the first ship group */ public void setShipAfterDate(Timestamp shipAfterDate) { this.setShipAfterDate(0, shipAfterDate); @@ -1166,8 +1166,8 @@ public class ShoppingCart implements Ite /** * Get ship after date for a particular ship group - * @param idx - * @return + * @param idx the ship group number + * @return return the ship after date for the given ship group */ public Timestamp getShipAfterDate(int idx) { CartShipInfo csi = this.getShipInfo(idx); @@ -1176,7 +1176,7 @@ public class ShoppingCart implements Ite /** * Get ship after date for ship group 0 - * @return + * @return return the ship after date for the first ship group */ public Timestamp getShipAfterDate() { return this.getShipAfterDate(0); @@ -1906,8 +1906,8 @@ public class ShoppingCart implements Ite /** * Returns ProductStoreFinActSetting based on cart's productStoreId and FinAccountHelper's defined giftCertFinAcctTypeId - * @param delegator - * @return + * @param delegator the delegator + * @return returns ProductStoreFinActSetting based on cart's productStoreId * @throws GenericEntityException */ public GenericValue getGiftCertSettingFromStore(Delegator delegator) throws GenericEntityException { @@ -1916,7 +1916,8 @@ public class ShoppingCart implements Ite /** * Determines whether pin numbers are required for gift cards, based on ProductStoreFinActSetting. Default to true. - * @return + * @param delegator the delegator + * @return returns true whether pin numbers are required for gift card */ public boolean isPinRequiredForGC(Delegator delegator) { try { @@ -1939,8 +1940,8 @@ public class ShoppingCart implements Ite /** * Returns whether the cart should validate gift cards against FinAccount (ie, internal gift certificates). Defaults to false. - * @param delegator - * @return + * @param delegator the delegator + * @return returns true whether the cart should validate gift cards against FinAccount */ public boolean isValidateGCFinAccount(Delegator delegator) { try { @@ -4642,7 +4643,7 @@ public class ShoppingCart implements Ite /** * Reset the ship group's shipBeforeDate if it is after the parameter - * @param newShipBeforeDate + * @param newShipBeforeDate the ship group's shipBeforeDate to be reset */ public void resetShipBeforeDateIfAfter(Timestamp newShipBeforeDate) { if (newShipBeforeDate != null) { @@ -4654,7 +4655,7 @@ public class ShoppingCart implements Ite /** * Reset the ship group's shipAfterDate if it is before the parameter - * @param newShipBeforeDate + * @param newShipAfterDate the ship group's shipAfterDate to be reset */ public void resetShipAfterDateIfBefore(Timestamp newShipAfterDate) { if (newShipAfterDate != null) { Modified: ofbiz/trunk/applications/order/src/org/ofbiz/order/shoppingcart/ShoppingCartItem.java URL: http://svn.apache.org/viewvc/ofbiz/trunk/applications/order/src/org/ofbiz/order/shoppingcart/ShoppingCartItem.java?rev=1126704&r1=1126703&r2=1126704&view=diff ============================================================================== --- ofbiz/trunk/applications/order/src/org/ofbiz/order/shoppingcart/ShoppingCartItem.java (original) +++ ofbiz/trunk/applications/order/src/org/ofbiz/order/shoppingcart/ShoppingCartItem.java Mon May 23 20:04:02 2011 @@ -273,12 +273,12 @@ public class ShoppingCartItem implements * * @param cartLocation The location to place this item; null will place at the end * @param productId The primary key of the product being added - * @param selectedAmountDbl Optional. Defaults to 0.0. If a selectedAmount is needed (complements the quantity value), pass it in here. + * @param selectedAmount Optional. Defaults to 0.0. If a selectedAmount is needed (complements the quantity value), pass it in here. * @param quantity Required. The quantity to add. - * @param unitPriceDbl Optional. Defaults to 0.0, which causes calculation of price. + * @param unitPrice Optional. Defaults to 0.0, which causes calculation of price. * @param reservStart Optional. The start of the reservation. - * @param reservLengthDbl Optional. The length of the reservation. - * @param reservPersonsDbl Optional. The number of persons taking advantage of the reservation. + * @param reservLength Optional. The length of the reservation. + * @param reservPersons Optional. The number of persons taking advantage of the reservation. * @param shipBeforeDate Optional. The date to ship the order by. * @param shipAfterDate Optional. Wait until this date to ship. * @param additionalProductFeatureAndAppls Optional. Product feature/appls map. @@ -371,12 +371,12 @@ public class ShoppingCartItem implements * * @param cartLocation The location to place this item; null will place at the end * @param product The product entity relating to the product being added - * @param selectedAmountDbl Optional. Defaults to 0.0. If a selectedAmount is needed (complements the quantity value), pass it in here. + * @param selectedAmount Optional. Defaults to 0.0. If a selectedAmount is needed (complements the quantity value), pass it in here. * @param quantity Required. The quantity to add. - * @param unitPriceDbl Optional. Defaults to 0.0, which causes calculation of price. + * @param unitPrice Optional. Defaults to 0.0, which causes calculation of price. * @param reservStart Optional. The start of the reservation. - * @param reservLengthDbl Optional. The length of the reservation. - * @param reservPersonsDbl Optional. The number of persons taking advantage of the reservation. + * @param reservLength Optional. The length of the reservation. + * @param reservPersons Optional. The number of persons taking advantage of the reservation. * @param shipBeforeDate Optional. The date to ship the order by. * @param shipAfterDate Optional. Wait until this date to ship. * @param additionalProductFeatureAndAppls Optional. Product feature/appls map. Modified: ofbiz/trunk/applications/order/src/org/ofbiz/order/shoppinglist/ShoppingListServices.java URL: http://svn.apache.org/viewvc/ofbiz/trunk/applications/order/src/org/ofbiz/order/shoppinglist/ShoppingListServices.java?rev=1126704&r1=1126703&r2=1126704&view=diff ============================================================================== --- ofbiz/trunk/applications/order/src/org/ofbiz/order/shoppinglist/ShoppingListServices.java (original) +++ ofbiz/trunk/applications/order/src/org/ofbiz/order/shoppinglist/ShoppingListServices.java Mon May 23 20:04:02 2011 @@ -411,10 +411,10 @@ public class ShoppingListServices { } /** * Create a new shoppingCart form a shoppingList - * @param dispatcher - * @param shoppingList - * @param locale - * @return + * @param dispatcher the local dispatcher + * @param shoppingList a GenericValue object of the shopping list + * @param locale the locale in use + * @return returns a new shopping cart form a shopping list */ public static ShoppingCart makeShoppingListCart(LocalDispatcher dispatcher, GenericValue shoppingList, Locale locale) { return makeShoppingListCart(null, dispatcher, shoppingList, locale); } @@ -422,11 +422,11 @@ public class ShoppingListServices { /** * Add a shoppinglist to an existing shoppingcart * - * @param shoppingCart - * @param dispatcher - * @param shoppingList - * @param locale - * @return + * @param listCart the shopping cart list + * @param dispatcher the local dispatcher + * @param shoppingList a GenericValue object of the shopping list + * @param locale the locale in use + * @return the modified shopping cart adding the shopping list elements */ public static ShoppingCart makeShoppingListCart(ShoppingCart listCart, LocalDispatcher dispatcher, GenericValue shoppingList, Locale locale) { Delegator delegator = dispatcher.getDelegator(); Modified: ofbiz/trunk/applications/party/src/org/ofbiz/party/communication/CommunicationEventServices.java URL: http://svn.apache.org/viewvc/ofbiz/trunk/applications/party/src/org/ofbiz/party/communication/CommunicationEventServices.java?rev=1126704&r1=1126703&r2=1126704&view=diff ============================================================================== --- ofbiz/trunk/applications/party/src/org/ofbiz/party/communication/CommunicationEventServices.java (original) +++ ofbiz/trunk/applications/party/src/org/ofbiz/party/communication/CommunicationEventServices.java Mon May 23 20:04:02 2011 @@ -679,9 +679,9 @@ public class CommunicationEventServices * However multiparts can contain multiparts. A recursive function has been added. * * -Al Byers - Hans Bakker - * @param dctx - * @param context - * @return + * @param dctx the dispatch context + * @param context the context + * @return returns the result of the service execution */ public static Map<String, Object> storeIncomingEmail(DispatchContext dctx, Map<String, ? extends Object> context) { Delegator delegator = dctx.getDelegator(); Modified: ofbiz/trunk/applications/party/src/org/ofbiz/party/contact/ContactMechWorker.java URL: http://svn.apache.org/viewvc/ofbiz/trunk/applications/party/src/org/ofbiz/party/contact/ContactMechWorker.java?rev=1126704&r1=1126703&r2=1126704&view=diff ============================================================================== --- ofbiz/trunk/applications/party/src/org/ofbiz/party/contact/ContactMechWorker.java (original) +++ ofbiz/trunk/applications/party/src/org/ofbiz/party/contact/ContactMechWorker.java Mon May 23 20:04:02 2011 @@ -467,10 +467,10 @@ public class ContactMechWorker { } /** Returns the first valid FacilityContactMech found based on the given facilityId and a prioritized list of purposes - * @param delegator - * @param facilityId - * @param purposeTypes A List of ContactMechPurposeType ids which will be checked one at a time until a valid contact mech is found - * @return + * @param delegator the delegator + * @param facilityId the facility id + * @param purposeTypes a List of ContactMechPurposeType ids which will be checked one at a time until a valid contact mech is found + * @return returns the first valid FacilityContactMech found based on the given facilityId and a prioritized list of purposes */ public static GenericValue getFacilityContactMechByPurpose(Delegator delegator, String facilityId, List<String> purposeTypes) { if (UtilValidate.isEmpty(facilityId)) return null; Modified: ofbiz/trunk/applications/party/src/org/ofbiz/party/party/PartyServices.java URL: http://svn.apache.org/viewvc/ofbiz/trunk/applications/party/src/org/ofbiz/party/party/PartyServices.java?rev=1126704&r1=1126703&r2=1126704&view=diff ============================================================================== --- ofbiz/trunk/applications/party/src/org/ofbiz/party/party/PartyServices.java (original) +++ ofbiz/trunk/applications/party/src/org/ofbiz/party/party/PartyServices.java Mon May 23 20:04:02 2011 @@ -1484,9 +1484,9 @@ public class PartyServices { * one party to another for the purpose of merging records together. Flags the from party * as disabled so it no longer appears in a search. * - * @param dctx - * @param context - * @return + * @param dctx the dispatch context + * @param context the context + * @return the result of the service execution */ public static Map<String, Object> linkParty(DispatchContext dctx, Map<String, ? extends Object> context) { Delegator _delegator = dctx.getDelegator(); @@ -1805,9 +1805,8 @@ public class PartyServices { /** * Finds partyId(s) corresponding to a party reference, partyId or a GoodIdentification idValue - * @param dctx - * @param context - * @param context.partyId use to search with partyId or goodIdentification.idValue + * @param ctx the dispatch context + * @param context use to search with partyId or goodIdentification.idValue * @return a GenericValue with a partyId and a List of complementary partyId found */ public static Map<String, Object> findPartyById(DispatchContext ctx, Map<String, Object> context) { Modified: ofbiz/trunk/applications/party/src/org/ofbiz/party/party/PartyWorker.java URL: http://svn.apache.org/viewvc/ofbiz/trunk/applications/party/src/org/ofbiz/party/party/PartyWorker.java?rev=1126704&r1=1126703&r2=1126704&view=diff ============================================================================== --- ofbiz/trunk/applications/party/src/org/ofbiz/party/party/PartyWorker.java (original) +++ ofbiz/trunk/applications/party/src/org/ofbiz/party/party/PartyWorker.java Mon May 23 20:04:02 2011 @@ -283,7 +283,7 @@ public class PartyWorker { } /** - * @deprecated Renamed to {@link #findMatchingPersonPartyAndPostalAddress(Delegator, String, String, String, String, String, String, String, String, String, String)} + * @deprecated Renamed to {@link #findMatchingPersonPostalAddresses(Delegator, String, String, String, String, String, String, String, String, String, String)} */ @Deprecated public static List<GenericValue> findMatchingPartyAndPostalAddress(Delegator delegator, String address1, String address2, String city, @@ -472,12 +472,12 @@ public class PartyWorker { * By default return the party find by partyId * but you can pass searchPartyFirst at false if you want search in partyIdentification before * or pass searchAllId at true to find apartyuct with this id (party.partyId and partyIdentification.idValue) - * @param delegator - * @param idToFind - * @param partyIdentificationTypeId - * @param searchPartyFirst - * @param searchAllId - * @return + * @param delegator the delegator + * @param idToFind the party id to find + * @param partyIdentificationTypeId the party identification type id to use + * @param searchPartyFirst search first with party id + * @param searchAllId search all the party ids + * @return returns the parties founds * @throws GenericEntityException */ public static List<GenericValue> findPartiesById(Delegator delegator, Modified: ofbiz/trunk/applications/product/src/org/ofbiz/product/config/ProductConfigWorker.java URL: http://svn.apache.org/viewvc/ofbiz/trunk/applications/product/src/org/ofbiz/product/config/ProductConfigWorker.java?rev=1126704&r1=1126703&r2=1126704&view=diff ============================================================================== --- ofbiz/trunk/applications/product/src/org/ofbiz/product/config/ProductConfigWorker.java (original) +++ ofbiz/trunk/applications/product/src/org/ofbiz/product/config/ProductConfigWorker.java Mon May 23 20:04:02 2011 @@ -179,8 +179,8 @@ public class ProductConfigWorker { * First search persisted configurations and update configWrapper.configId if found. * Otherwise store ProductConfigWrapper to ProductConfigConfig entity and updates configWrapper.configId with new configId * This method persists only the selected options, price data is lost. - * @param ProductConfigWrapper - * @param delegator + * @param configWrapper the ProductConfigWrapper object + * @param delegator the delegator */ public static void storeProductConfigWrapper(ProductConfigWrapper configWrapper, Delegator delegator) { if (configWrapper == null || (!configWrapper.isCompleted())) return; Modified: ofbiz/trunk/applications/product/src/org/ofbiz/product/inventory/InventoryWorker.java URL: http://svn.apache.org/viewvc/ofbiz/trunk/applications/product/src/org/ofbiz/product/inventory/InventoryWorker.java?rev=1126704&r1=1126703&r2=1126704&view=diff ============================================================================== --- ofbiz/trunk/applications/product/src/org/ofbiz/product/inventory/InventoryWorker.java (original) +++ ofbiz/trunk/applications/product/src/org/ofbiz/product/inventory/InventoryWorker.java Mon May 23 20:04:02 2011 @@ -43,9 +43,9 @@ public class InventoryWorker { /** * Finds all outstanding Purchase orders for a productId. The orders and the items cannot be completed, cancelled, or rejected - * @param productId - * @param delegator - * @return + * @param productId the product id + * @param delegator the delegator + * @return returns all outstanding Purchase orders for a productId */ public static List<GenericValue> getOutstandingPurchaseOrders(String productId, Delegator delegator) { try { @@ -68,9 +68,9 @@ public class InventoryWorker { /** * Finds the net outstanding ordered quantity for a productId, netting quantity on outstanding purchase orders against cancelQuantity - * @param productId - * @param delegator - * @return + * @param productId the product id + * @param delegator the delegator + * @return returns the net outstanding ordered quantity for a productId */ public static BigDecimal getOutstandingPurchasedQuantity(String productId, Delegator delegator) { BigDecimal qty = BigDecimal.ZERO; Modified: ofbiz/trunk/applications/product/src/org/ofbiz/product/product/ProductSearchSession.java URL: http://svn.apache.org/viewvc/ofbiz/trunk/applications/product/src/org/ofbiz/product/product/ProductSearchSession.java?rev=1126704&r1=1126703&r2=1126704&view=diff ============================================================================== --- ofbiz/trunk/applications/product/src/org/ofbiz/product/product/ProductSearchSession.java (original) +++ ofbiz/trunk/applications/product/src/org/ofbiz/product/product/ProductSearchSession.java Mon May 23 20:04:02 2011 @@ -152,19 +152,22 @@ public class ProductSearchSession { } /** - * @return Returns the viewIndex. + * Get the view size + * @return returns the viewIndex. */ public Integer getViewIndex() { return viewIndex; } /** - * @param viewIndex The viewIndex to set. + * Set the view index + * @param viewIndex the viewIndex to set. */ public void setViewIndex(Integer viewIndex) { this.viewIndex = viewIndex; } /** - * @param viewIndex The viewIndex to set. + * Set the view index + * @param viewIndexStr the viewIndex to set. */ public void setViewIndex(String viewIndexStr) { if (UtilValidate.isEmpty(viewIndexStr)) { @@ -181,14 +184,16 @@ public class ProductSearchSession { } /** - * @return Returns the viewSize. + * Get the view size + * @return returns the view size. */ public Integer getViewSize() { return viewSize; } /** - * @param viewSize The viewSize to set. + * Set the view size + * @param viewSize the view size to set. */ public void setViewSize(Integer viewSize) { setPreviousViewSize(getViewSize()); @@ -196,7 +201,8 @@ public class ProductSearchSession { } /** - * @param viewSize The viewSize to set. + * Set the view size + * @param viewSizeStr the view size to set. */ public void setViewSize(String viewSizeStr) { if (UtilValidate.isEmpty(viewSizeStr)) { @@ -213,14 +219,16 @@ public class ProductSearchSession { } /** - * @return Returns the paging. + * Get the paging + * @return Returns the paging */ public String getPaging() { return paging; } /** - * @param paging The paging to set. + * Set the paging + * @param paging the paging to set */ public void setPaging(String paging) { if (paging == null) { @@ -230,13 +238,15 @@ public class ProductSearchSession { } /** - * @return Returns the previousViewSize. + * Get the previous view size + * @return returns the previous view size */ public Integer getPreviousViewSize() { return previousViewSize; } /** - * @param previousViewSize The previousViewSize to set. + * Set the previous view size + * @param previousViewSize the previousViewSize to set. */ public void setPreviousViewSize(Integer previousViewSize) { if (previousViewSize == null) { Modified: ofbiz/trunk/applications/product/src/org/ofbiz/product/product/ProductServices.java URL: http://svn.apache.org/viewvc/ofbiz/trunk/applications/product/src/org/ofbiz/product/product/ProductServices.java?rev=1126704&r1=1126703&r2=1126704&view=diff ============================================================================== --- ofbiz/trunk/applications/product/src/org/ofbiz/product/product/ProductServices.java (original) +++ ofbiz/trunk/applications/product/src/org/ofbiz/product/product/ProductServices.java Mon May 23 20:04:02 2011 @@ -1225,9 +1225,8 @@ public class ProductServices { /** * Finds productId(s) corresponding to a product reference, productId or a GoodIdentification idValue - * @param dctx - * @param context - * @param context.productId use to search with productId or goodIdentification.idValue + * @param ctx the dispatch context + * @param context productId use to search with productId or goodIdentification.idValue * @return a GenericValue with a productId and a List of complementary productId found */ public static Map<String, Object> findProductById(DispatchContext ctx, Map<String, Object> context) { Modified: ofbiz/trunk/applications/product/src/org/ofbiz/product/product/ProductWorker.java URL: http://svn.apache.org/viewvc/ofbiz/trunk/applications/product/src/org/ofbiz/product/product/ProductWorker.java?rev=1126704&r1=1126703&r2=1126704&view=diff ============================================================================== --- ofbiz/trunk/applications/product/src/org/ofbiz/product/product/ProductWorker.java (original) +++ ofbiz/trunk/applications/product/src/org/ofbiz/product/product/ProductWorker.java Mon May 23 20:04:02 2011 @@ -842,12 +842,12 @@ public class ProductWorker { * By default return the product find by productId * but you can pass searchProductFirst at false if you want search in goodIdentification before * or pass searchAllId at true to find all product with this id (product.productId and goodIdentification.idValue) - * @param delegator - * @param idToFind - * @param goodIdentificationTypeId - * @param searchProductFirst - * @param searchAllId - * @return + * @param delegator the delegator + * @param idToFind the product id to find + * @param goodIdentificationTypeId the good identification type id to use + * @param searchProductFirst search first by product id + * @param searchAllId search all product ids + * @return return the list of products founds * @throws GenericEntityException */ public static List<GenericValue> findProductsById(Delegator delegator, Modified: ofbiz/trunk/applications/product/src/org/ofbiz/product/spreadsheetimport/ImportProductServices.java URL: http://svn.apache.org/viewvc/ofbiz/trunk/applications/product/src/org/ofbiz/product/spreadsheetimport/ImportProductServices.java?rev=1126704&r1=1126703&r2=1126704&view=diff ============================================================================== --- ofbiz/trunk/applications/product/src/org/ofbiz/product/spreadsheetimport/ImportProductServices.java (original) +++ ofbiz/trunk/applications/product/src/org/ofbiz/product/spreadsheetimport/ImportProductServices.java Mon May 23 20:04:02 2011 @@ -57,9 +57,9 @@ public class ImportProductServices { * Note : Create the spreadsheet directory in the ofbiz home folder and keep * your xls files in this folder only. * - * @param dctx - * @param context - * @return + * @param dctx the dispatch context + * @param context the context + * @return the result of the service execution */ public static Map<String, Object> productImportFromSpreadsheet(DispatchContext dctx, Map<String, ? extends Object> context) { Delegator delegator = dctx.getDelegator(); Modified: ofbiz/trunk/applications/product/src/org/ofbiz/shipment/packing/PackingServices.java URL: http://svn.apache.org/viewvc/ofbiz/trunk/applications/product/src/org/ofbiz/shipment/packing/PackingServices.java?rev=1126704&r1=1126703&r2=1126704&view=diff ============================================================================== --- ofbiz/trunk/applications/product/src/org/ofbiz/shipment/packing/PackingServices.java (original) +++ ofbiz/trunk/applications/product/src/org/ofbiz/shipment/packing/PackingServices.java Mon May 23 20:04:02 2011 @@ -87,9 +87,9 @@ public class PackingServices { * Packs the same items n times in consecutive packages, starting from the package number retrieved from pkgInfo.</li> * </ul> * </p> - * @param dctx - * @param context - * @return + * @param dctx the dispatch context + * @param context the context + * @return returns the result of the service execution */ public static Map<String, Object> packBulk(DispatchContext dctx, Map<String, ? extends Object> context) { PackingSession session = (PackingSession) context.get("packingSession"); Modified: ofbiz/trunk/applications/workeffort/src/org/ofbiz/workeffort/workeffort/ICalWorker.java URL: http://svn.apache.org/viewvc/ofbiz/trunk/applications/workeffort/src/org/ofbiz/workeffort/workeffort/ICalWorker.java?rev=1126704&r1=1126703&r2=1126704&view=diff ============================================================================== --- ofbiz/trunk/applications/workeffort/src/org/ofbiz/workeffort/workeffort/ICalWorker.java (original) +++ ofbiz/trunk/applications/workeffort/src/org/ofbiz/workeffort/workeffort/ICalWorker.java Mon May 23 20:04:02 2011 @@ -92,7 +92,7 @@ public class ICalWorker { * * @param statusMessage Optional status message - usually <code>null</code> * for security reasons - * @return + * @return Create an HTTP Forbidden response */ public static ResponseProperties createForbiddenResponse(String statusMessage) { return new ResponseProperties(HttpServletResponse.SC_FORBIDDEN, statusMessage); @@ -105,7 +105,7 @@ public class ICalWorker { * * @param statusMessage Optional status message - usually <code>null</code> * for security reasons - * @return + * @return Create an HTTP Unauthorized response */ public static ResponseProperties createNotAuthorizedResponse(String statusMessage) { return new ResponseProperties(HttpServletResponse.SC_UNAUTHORIZED, statusMessage); @@ -124,7 +124,7 @@ public class ICalWorker { * * @param statusMessage A message describing which calendar components were * not updated - * @return + * @return Create an HTTP Partial Content response. */ public static ResponseProperties createPartialContentResponse(String statusMessage) { return new ResponseProperties(HttpServletResponse.SC_PARTIAL_CONTENT, statusMessage); Modified: ofbiz/trunk/applications/workeffort/src/org/ofbiz/workeffort/workeffort/WorkEffortServices.java URL: http://svn.apache.org/viewvc/ofbiz/trunk/applications/workeffort/src/org/ofbiz/workeffort/workeffort/WorkEffortServices.java?rev=1126704&r1=1126703&r2=1126704&view=diff ============================================================================== --- ofbiz/trunk/applications/workeffort/src/org/ofbiz/workeffort/workeffort/WorkEffortServices.java (original) +++ ofbiz/trunk/applications/workeffort/src/org/ofbiz/workeffort/workeffort/WorkEffortServices.java Mon May 23 20:04:02 2011 @@ -890,9 +890,9 @@ public class WorkEffortServices { } /** Process work effort event reminders. This service is used by the job scheduler. - * @param ctx - * @param context - * @return + * @param ctx the dispatch context + * @param context the context + * @return returns the result of the service execution */ public static Map<String, Object> processWorkEffortEventReminders(DispatchContext ctx, Map<String, ? extends Object> context) { Delegator delegator = ctx.getDelegator(); @@ -1095,9 +1095,9 @@ public class WorkEffortServices { } /** Migrate work effort event reminders. - * @param ctx - * @param context - * @return + * @param ctx the dispatch context + * @param context the context + * @return returns the result of the service execution */ public static Map<String, Object> migrateWorkEffortEventReminders(DispatchContext ctx, Map<String, ? extends Object> context) { Delegator delegator = ctx.getDelegator(); |
«
Return to OFBiz - Commits
|
1 view|%1 views
| Free forum by Nabble | Edit this page |