diff --git a/applications/accounting/src/main/java/org/apache/ofbiz/accounting/invoice/InvoiceWorker.java b/applications/accounting/src/main/java/org/apache/ofbiz/accounting/invoice/InvoiceWorker.java index a08d5f4e5e..0c4c88832c 100644 --- a/applications/accounting/src/main/java/org/apache/ofbiz/accounting/invoice/InvoiceWorker.java +++ b/applications/accounting/src/main/java/org/apache/ofbiz/accounting/invoice/InvoiceWorker.java @@ -369,7 +369,7 @@ public final class InvoiceWorker { return InvoiceWorker.getInvoiceTotal(invoice, actualCurrency).subtract(getInvoiceApplied(invoice, actualCurrency)); } /** - * Returns amount not applied (i.e., still outstanding) of an invoice at an asOfDate, based on Payment.effectiveDate <= asOfDateTime + * Returns amount not applied (i.e., still outstanding) of an invoice at an asOfDate, based on Payment.effectiveDate <= asOfDateTime * * @param invoice GenericValue object of the invoice * @param asOfDateTime the date to use @@ -391,7 +391,7 @@ public final class InvoiceWorker { } /** - * Returns amount applied to invoice before an asOfDateTime, based on Payment.effectiveDate <= asOfDateTime + * Returns amount applied to invoice before an asOfDateTime, based on Payment.effectiveDate <= asOfDateTime * * @param delegator the delegator * @param invoiceId the invoice id diff --git a/applications/accounting/src/main/java/org/apache/ofbiz/accounting/payment/PaymentGatewayServices.java b/applications/accounting/src/main/java/org/apache/ofbiz/accounting/payment/PaymentGatewayServices.java index 73feb6043f..8fdd68f671 100644 --- a/applications/accounting/src/main/java/org/apache/ofbiz/accounting/payment/PaymentGatewayServices.java +++ b/applications/accounting/src/main/java/org/apache/ofbiz/accounting/payment/PaymentGatewayServices.java @@ -3333,7 +3333,7 @@ public class PaymentGatewayServices { /** - * Simple test processor; declines all orders < 100.00; approves all orders >= 100.00 + * Simple test processor; declines all orders < 100.00; approves all orders >= 100.00 */ public static Map testProcessor(DispatchContext dctx, Map context) { Locale locale = (Locale) context.get("locale"); @@ -3363,7 +3363,7 @@ public class PaymentGatewayServices { /** - * Simple test processor; declines all orders < 100.00; approves all orders > 100.00 + * Simple test processor; declines all orders < 100.00; approves all orders > 100.00 */ public static Map testProcessorWithCapture(DispatchContext dctx, Map context) { Locale locale = (Locale) context.get("locale"); diff --git a/applications/manufacturing/src/main/java/org/apache/ofbiz/manufacturing/jobshopmgt/ProductionRun.java b/applications/manufacturing/src/main/java/org/apache/ofbiz/manufacturing/jobshopmgt/ProductionRun.java index 481a239ad7..741c27c3f9 100644 --- a/applications/manufacturing/src/main/java/org/apache/ofbiz/manufacturing/jobshopmgt/ProductionRun.java +++ b/applications/manufacturing/src/main/java/org/apache/ofbiz/manufacturing/jobshopmgt/ProductionRun.java @@ -113,11 +113,13 @@ public class ProductionRun { return productionRun; } /** - * store the modified ProductionRun object in the database. - *
  • store the the productionRun header - *
  • the productProduced related data - *
  • the listRoutingTask related data - *
  • the productComponent list related data + * Store the modified ProductionRun object in the database. + *
      + *
    • store the the productionRun header
    • + *
    • the productProduced related data
    • + *
    • the listRoutingTask related data
    • + *
    • the productComponent list related data
    • + *
    * @return true if success false otherwise **/ public boolean store() { @@ -245,10 +247,10 @@ public class ProductionRun { this.estimatedCompletionDate = estimatedCompletionDate; } /** - * recalculated the estimatedCompletionDate property. - * Use the quantity and the estimatedStartDate properties as entries parameters. - *
    read the listRoutingTask and for each recalculated and update the estimatedStart and endDate in the object. - *
    no store in the database is done. + * Recalculate the estimatedCompletionDate property. + * Use the quantity and the estimatedStartDate properties as entries parameters. + * Read the listRoutingTask and for each recalculated and update the estimatedStart and endDate in the object. + * No store in the database is done. * @param priority give the routingTask start point to recalculated * @return the estimatedCompletionDate calculated **/ diff --git a/applications/manufacturing/src/main/java/org/apache/ofbiz/manufacturing/jobshopmgt/ProductionRunHelper.java b/applications/manufacturing/src/main/java/org/apache/ofbiz/manufacturing/jobshopmgt/ProductionRunHelper.java index a5d995eddf..33c1513a0c 100644 --- a/applications/manufacturing/src/main/java/org/apache/ofbiz/manufacturing/jobshopmgt/ProductionRunHelper.java +++ b/applications/manufacturing/src/main/java/org/apache/ofbiz/manufacturing/jobshopmgt/ProductionRunHelper.java @@ -45,12 +45,11 @@ public final class ProductionRunHelper { /** * Get a Production Run. - *
  • check if routing - product link exist + * Check if routing - product link exists. + * * @param delegator the delegator * @param productionRunId the production run id * @return Map with the result of the service, the output parameters are - *
  • the productionRun - *
  • the productionRunProduct */ public static Map getProductionRun(Delegator delegator, String productionRunId) { Map result = new HashMap(); diff --git a/applications/manufacturing/src/main/java/org/apache/ofbiz/manufacturing/jobshopmgt/ProductionRunServices.java b/applications/manufacturing/src/main/java/org/apache/ofbiz/manufacturing/jobshopmgt/ProductionRunServices.java index db636bb59e..d2f01c1ec7 100644 --- a/applications/manufacturing/src/main/java/org/apache/ofbiz/manufacturing/jobshopmgt/ProductionRunServices.java +++ b/applications/manufacturing/src/main/java/org/apache/ofbiz/manufacturing/jobshopmgt/ProductionRunServices.java @@ -174,14 +174,16 @@ public class ProductionRunServices { /** * Creates a Production Run. - *
  • check if routing - product link exist - *
  • check if product have a Bill Of Material - *
  • check if routing have routingTask - *
  • create the workEffort for ProductionRun - *
  • create the WorkEffortGoodStandard for link between ProductionRun and the product it will produce - *
  • for each valid routingTask of the routing create a workeffort-task - *
  • for the first routingTask, create for all the valid productIdTo with no associateRoutingTask a WorkEffortGoodStandard - *
  • for each valid routingTask of the routing and valid productIdTo associate with this RoutingTask create a WorkEffortGoodStandard + *
      + *
    • check if routing - product link exist
    • + *
    • check if product have a Bill Of Material
    • + *
    • check if routing have routingTask
    • + *
    • create the workEffort for ProductionRun
    • + *
    • create the WorkEffortGoodStandard for link between ProductionRun and the product it will produce
    • + *
    • for each valid routingTask of the routing create a workeffort-task
    • + *
    • for the first routingTask, create for all the valid productIdTo with no associateRoutingTask a WorkEffortGoodStandard
    • + *
    • for each valid routingTask of the routing and valid productIdTo associate with this RoutingTask create a WorkEffortGoodStandard
    • + *
    * @param ctx The DispatchContext that this service is operating in. * @param context Map containing the input parameters, productId, routingId, pRQuantity, startDate, workEffortName, description * @return Map with the result of the service, the output parameters. @@ -481,11 +483,13 @@ public class ProductionRunServices { /** * Update a Production Run. - *
  • update field and after recalculate the entire ProductionRun data (routingTask and productComponent) - *
  • create the WorkEffortGoodStandard for link between ProductionRun and the product it will produce - *
  • for each valid routingTask of the routing create a workeffort-task - *
  • for the first routingTask, create for all the valid productIdTo with no associateRoutingTask a WorkEffortGoodStandard - *
  • for each valid routingTask of the routing and valid productIdTo associate with this RoutingTask create a WorkEffortGoodStandard + *
      + *
    • update field and after recalculate the entire ProductionRun data (routingTask and productComponent)
    • + *
    • create the WorkEffortGoodStandard for link between ProductionRun and the product it will produce
    • + *
    • for each valid routingTask of the routing create a workeffort-task
    • + *
    • for the first routingTask, create for all the valid productIdTo with no associateRoutingTask a WorkEffortGoodStandard
    • + *
    • for each valid routingTask of the routing and valid productIdTo associate with this RoutingTask create a WorkEffortGoodStandard
    • + *
    * @param ctx The DispatchContext that this service is operating in. * @param context Map containing the input parameters, productId, routingId, quantity, estimatedStartDate, workEffortName, description * @return Map with the result of the service, the output parameters. @@ -1198,12 +1202,14 @@ public class ProductionRunServices { } /** - * check if field for routingTask update are correct and if need recalculated data in Production Run. - * Check
      - *
    • if estimatedStartDate is not before Production Run estimatedStartDate.
    - *
  • if there is not a another routingTask with the same priority - * If priority or estimatedStartDate has changed recalculated data for routingTask after that one. - *
    update the productionRun + * Check if field for routingTask update are correct and if need recalculated data in Production Run. + * Check + *
      + *
    • if estimatedStartDate is not before Production Run estimatedStartDate.
    • + *
    • if there is not a another routingTask with the same priority
    • + *
    • If priority or estimatedStartDate has changed recalculated data for routingTask after that one.
    • + *
    + * Update the productionRun * @param ctx The DispatchContext that this service is operating in. * @param context Map containing the input parameters, productId, routingId, priority, estimatedStartDate, estimatedSetupMillis, estimatedMilliSeconds * @return Map with the result of the service, the output parameters, estimatedCompletionDate. diff --git a/applications/manufacturing/src/main/java/org/apache/ofbiz/manufacturing/techdata/TechDataServices.java b/applications/manufacturing/src/main/java/org/apache/ofbiz/manufacturing/techdata/TechDataServices.java index 16ebd181a2..14a39720d2 100644 --- a/applications/manufacturing/src/main/java/org/apache/ofbiz/manufacturing/techdata/TechDataServices.java +++ b/applications/manufacturing/src/main/java/org/apache/ofbiz/manufacturing/techdata/TechDataServices.java @@ -59,7 +59,7 @@ public class TechDataServices { * * @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" + * @return result a map containing lookupResult (list of RoutingTask <=> workEffortId with currentStatusId = "ROU_ACTIVE" and workEffortTypeId = "ROU_TASK" */ public static Map lookupRoutingTask(DispatchContext ctx, Map context) { Delegator delegator = ctx.getDelegator(); diff --git a/framework/entity/src/main/java/org/apache/ofbiz/entity/jdbc/SqlJdbcUtil.java b/framework/entity/src/main/java/org/apache/ofbiz/entity/jdbc/SqlJdbcUtil.java index 6d5816c25b..dca75815f0 100644 --- a/framework/entity/src/main/java/org/apache/ofbiz/entity/jdbc/SqlJdbcUtil.java +++ b/framework/entity/src/main/java/org/apache/ofbiz/entity/jdbc/SqlJdbcUtil.java @@ -280,7 +280,7 @@ public final class SqlJdbcUtil { return sql.toString(); } - /** Makes a WHERE clause String with "=?" if not null or " IS null" if null, all AND separated */ + /** Makes a WHERE clause String with "<col name>=?" if not null or "<col name> IS null" if null, all AND separated */ @Deprecated public static String makeWhereStringFromFields(List modelFields, Map fields, String operator) { return makeWhereStringFromFields(new StringBuilder(), modelFields, fields, operator, null).toString(); @@ -290,13 +290,13 @@ public final class SqlJdbcUtil { return makeWhereStringFromFields(sb, modelFields, fields, operator, null); } - /** Makes a WHERE clause String with "=?" if not null or " IS null" if null, all AND separated */ + /** Makes a WHERE clause String with "<col name>=?" if not null or "<col name> IS null" if null, all AND separated */ @Deprecated public static String makeWhereStringFromFields(List modelFields, Map fields, String operator, List entityConditionParams) { return makeWhereStringFromFields(new StringBuilder(), modelFields, fields, operator, entityConditionParams).toString(); } - /** Makes a WHERE clause String with "=?" if not null or " IS null" if null, all AND separated */ + /** Makes a WHERE clause String with "<col name>=?" if not null or "<col name> IS null" if null, all AND separated */ public static StringBuilder makeWhereStringFromFields(StringBuilder sb, List modelFields, Map fields, String operator, List entityConditionParams) { if (modelFields.size() < 1) { return sb; diff --git a/framework/minilang/src/main/java/org/apache/ofbiz/minilang/SimpleMethod.java b/framework/minilang/src/main/java/org/apache/ofbiz/minilang/SimpleMethod.java index 5c4cfe5d15..01ba25bcc6 100644 --- a/framework/minilang/src/main/java/org/apache/ofbiz/minilang/SimpleMethod.java +++ b/framework/minilang/src/main/java/org/apache/ofbiz/minilang/SimpleMethod.java @@ -67,7 +67,7 @@ import org.w3c.dom.Element; * has a model class, and each model class has its own factory. *

    *

    - * Mini-language can be extended by:
    + * Mini-language can be extended by:

    *
      *
    • Creating model classes that extend {@link org.apache.ofbiz.minilang.method.MethodOperation}
    • *
    • Creating factories for the model classes that implement {@link org.apache.ofbiz.minilang.method.MethodOperation.Factory}
    • @@ -75,7 +75,7 @@ import org.w3c.dom.Element; * (see ServiceLoader) * *
    - *

    + * * @see Mini-language Reference */ public final class SimpleMethod extends MiniLangElement { diff --git a/framework/service/src/main/java/org/apache/ofbiz/service/LocalDispatcher.java b/framework/service/src/main/java/org/apache/ofbiz/service/LocalDispatcher.java index 380331dce3..f04dfe2a0c 100644 --- a/framework/service/src/main/java/org/apache/ofbiz/service/LocalDispatcher.java +++ b/framework/service/src/main/java/org/apache/ofbiz/service/LocalDispatcher.java @@ -36,20 +36,17 @@ public interface LocalDispatcher { /** * Disables running of Service Engine Condition Actions (SECAs). Intended to be turned off temporarily. - * @throws GenericServiceException */ void disableEcas(); /** * Reenables running of Service Engine Condition Actions (SECAs). - * @throws GenericServiceException */ void enableEcas(); /** * Returns whether Service Engine Condition Actions (SECAs) are disabled or not. * @return returns whether Service Engine Condition Actions (SECAs) are disabled or not. - * @throws GenericServiceException */ boolean isEcasDisabled(); diff --git a/framework/service/src/main/java/org/apache/ofbiz/service/engine/ScriptEngine.java b/framework/service/src/main/java/org/apache/ofbiz/service/engine/ScriptEngine.java index fecd7b0bab..f94955b0d7 100644 --- a/framework/service/src/main/java/org/apache/ofbiz/service/engine/ScriptEngine.java +++ b/framework/service/src/main/java/org/apache/ofbiz/service/engine/ScriptEngine.java @@ -40,13 +40,13 @@ import org.apache.ofbiz.service.ServiceUtil; /** * Generic Script Service Engine. This service engine uses the javax.script package (JSR-223) to invoke scripts or script functions. - *

    The script service engine will put the following artifacts in the script engine's bindings:
    + *

    The script service engine will put the following artifacts in the script engine's bindings:

    *
      *
    • parameters - the service attributes Map
    • *
    • dctx - a DispatchContext instance
    • *
    • dispatcher - a LocalDispatcher instance
    • *
    • delegator - a Delegator instance
    • - *

    + * *

    If the service definition includes an invoke attribute, then the matching script function/method will be called * with a single argument - the bindings Map.

    */ diff --git a/framework/webapp/src/main/java/org/apache/ofbiz/webapp/ftl/OfbizUrlTransform.java b/framework/webapp/src/main/java/org/apache/ofbiz/webapp/ftl/OfbizUrlTransform.java index 6e7f25ebed..a9bc3f882b 100644 --- a/framework/webapp/src/main/java/org/apache/ofbiz/webapp/ftl/OfbizUrlTransform.java +++ b/framework/webapp/src/main/java/org/apache/ofbiz/webapp/ftl/OfbizUrlTransform.java @@ -43,14 +43,14 @@ import freemarker.template.TemplateTransformModel; /** * Freemarker Transform for creating OFBiz URLs (links). - *

    This transform accepts several arguments:
    + *

    This transform accepts several arguments:

    *
      *
    • fullPath (true/false) - generate a full URL including scheme and host, defaults to false.
    • *
    • secure (true/false) - generate a secure (https) URL, defaults to false. Server settings will * override this argument.
    • *
    • encode (true/false) - encode the URL, defaults to true. Encoding is UTF-8.
    • *
    • webSiteId - generate a full URL using the web site settings found in the WebSite entity.
    • - *

    + * *

    In addition, this transform accepts an environment variable - urlPrefix. If the variable * exists, it is prepended to the contents of the transform (the part between * <@ofbizUrl> and </@ofbizUrl>), and all transform arguments are diff --git a/framework/webtools/src/main/java/org/apache/ofbiz/webtools/WebToolsServices.java b/framework/webtools/src/main/java/org/apache/ofbiz/webtools/WebToolsServices.java index e5b01d6e30..46073e6e2f 100644 --- a/framework/webtools/src/main/java/org/apache/ofbiz/webtools/WebToolsServices.java +++ b/framework/webtools/src/main/java/org/apache/ofbiz/webtools/WebToolsServices.java @@ -563,7 +563,8 @@ public class WebToolsServices { /** Get entity reference data. Returns the number of entities in * numberOfEntities and a List of Maps - - * packagesList.
    Each Map contains:
    + * packagesList. + * Each Map contains:
    *

    • packageName - the entity package name
    • *
    • entitiesList - a list of Maps:
        diff --git a/specialpurpose/passport/src/main/java/org/apache/ofbiz/passport/user/GitHubAuthenticator.java b/specialpurpose/passport/src/main/java/org/apache/ofbiz/passport/user/GitHubAuthenticator.java index 996d98c388..0955061259 100644 --- a/specialpurpose/passport/src/main/java/org/apache/ofbiz/passport/user/GitHubAuthenticator.java +++ b/specialpurpose/passport/src/main/java/org/apache/ofbiz/passport/user/GitHubAuthenticator.java @@ -90,7 +90,7 @@ public class GitHubAuthenticator implements Authenticator { * externalAuthId, and the externalAuthId has a valid accessToken in * GitHubUser entity. * - * @param username User's username + * @param userLoginId User's login id * @param password User's password * @param isServiceAuth true if authentication is for a service call * @return true if the user is authenticated diff --git a/specialpurpose/passport/src/main/java/org/apache/ofbiz/passport/user/LinkedInAuthenticator.java b/specialpurpose/passport/src/main/java/org/apache/ofbiz/passport/user/LinkedInAuthenticator.java index 41c7ccce4e..83848ec8d7 100644 --- a/specialpurpose/passport/src/main/java/org/apache/ofbiz/passport/user/LinkedInAuthenticator.java +++ b/specialpurpose/passport/src/main/java/org/apache/ofbiz/passport/user/LinkedInAuthenticator.java @@ -91,7 +91,7 @@ public class LinkedInAuthenticator implements Authenticator { * externalAuthId, and the externalAuthId has a valid accessToken in * LinkedInUser entity. * - * @param username User's username + * @param userLoginId User's login id * @param password User's password * @param isServiceAuth true if authentication is for a service call * @return true if the user is authenticated