svn commit: r1126729 - in /ofbiz/trunk/framework/service/src/org/ofbiz/service: ./ calendar/ engine/ jms/ test/

[mrisaliti]

Author: mrisaliti
Date: Mon May 23 20:38:36 2011
New Revision: 1126729

URL: http://svn.apache.org/viewvc?rev=1126729&view=rev
Log:
Removed some javadoc warning (wrong param/return) into service component no functional changes

Modified:
    ofbiz/trunk/framework/service/src/org/ofbiz/service/GenericAbstractDispatcher.java
    ofbiz/trunk/framework/service/src/org/ofbiz/service/GenericInvoker.java
    ofbiz/trunk/framework/service/src/org/ofbiz/service/LocalDispatcher.java
    ofbiz/trunk/framework/service/src/org/ofbiz/service/ModelService.java
    ofbiz/trunk/framework/service/src/org/ofbiz/service/ServiceDispatcher.java
    ofbiz/trunk/framework/service/src/org/ofbiz/service/calendar/ExpressionUiHelper.java
    ofbiz/trunk/framework/service/src/org/ofbiz/service/calendar/TemporalExpressions.java
    ofbiz/trunk/framework/service/src/org/ofbiz/service/engine/AbstractEngine.java
    ofbiz/trunk/framework/service/src/org/ofbiz/service/engine/GenericEngine.java
    ofbiz/trunk/framework/service/src/org/ofbiz/service/jms/AbstractJmsListener.java
    ofbiz/trunk/framework/service/src/org/ofbiz/service/test/ServiceEngineTestServices.java

Modified: ofbiz/trunk/framework/service/src/org/ofbiz/service/GenericAbstractDispatcher.java
URL: http://svn.apache.org/viewvc/ofbiz/trunk/framework/service/src/org/ofbiz/service/GenericAbstractDispatcher.java?rev=1126729&r1=1126728&r2=1126729&view=diff
==============================================================================
--- ofbiz/trunk/framework/service/src/org/ofbiz/service/GenericAbstractDispatcher.java (original)
+++ ofbiz/trunk/framework/service/src/org/ofbiz/service/GenericAbstractDispatcher.java Mon May 23 20:38:36 2011
@@ -117,9 +117,6 @@ public abstract class GenericAbstractDis
         schedule(jobName, poolName, serviceName, ServiceUtil.makeContext(context), startTime, frequency, interval, count, endTime, maxRetry);
     }
 
-    /**
-     * @see org.ofbiz.service.LocalDispatcher#setRollbackService(java.lang.String, java.util.Map, boolean)
-     */
     public void addRollbackService(String serviceName, Map<String, ? extends Object> context, boolean persist) throws GenericServiceException {
         ServiceXaWrapper xa = new ServiceXaWrapper(this.getDispatchContext());
         xa.setRollbackService(serviceName, context, true, persist);
@@ -135,9 +132,6 @@ public abstract class GenericAbstractDis
         addRollbackService(serviceName, ServiceUtil.makeContext(context), persist);
     }
 
-    /**
-     * @see org.ofbiz.service.LocalDispatcher#setCommitService(java.lang.String, java.util.Map, boolean)
-     */
     public void addCommitService(String serviceName, Map<String, ? extends Object> context, boolean persist) throws GenericServiceException {
         ServiceXaWrapper xa = new ServiceXaWrapper(this.getDispatchContext());
         xa.setCommitService(serviceName, context, true, persist);

Modified: ofbiz/trunk/framework/service/src/org/ofbiz/service/GenericInvoker.java
URL: http://svn.apache.org/viewvc/ofbiz/trunk/framework/service/src/org/ofbiz/service/GenericInvoker.java?rev=1126729&r1=1126728&r2=1126729&view=diff
==============================================================================
--- ofbiz/trunk/framework/service/src/org/ofbiz/service/GenericInvoker.java (original)
+++ ofbiz/trunk/framework/service/src/org/ofbiz/service/GenericInvoker.java Mon May 23 20:38:36 2011
@@ -67,7 +67,7 @@ public interface GenericInvoker extends
      * Send the service callbacks
      * @param engine GenericEngine object
      * @param context Map of name, value pairs composing the context
-     * @param cbObj Object to return to callback (Throwable or Map)
+     * @param result Object to return to callback (Throwable or Map)
      * @param mode Service mode (sync or async)
      * @throws GenericServiceException
      */

Modified: ofbiz/trunk/framework/service/src/org/ofbiz/service/LocalDispatcher.java
URL: http://svn.apache.org/viewvc/ofbiz/trunk/framework/service/src/org/ofbiz/service/LocalDispatcher.java?rev=1126729&r1=1126728&r2=1126729&view=diff
==============================================================================
--- ofbiz/trunk/framework/service/src/org/ofbiz/service/LocalDispatcher.java (original)
+++ ofbiz/trunk/framework/service/src/org/ofbiz/service/LocalDispatcher.java Mon May 23 20:38:36 2011
@@ -45,7 +45,7 @@ public interface LocalDispatcher {
 
     /**
      * Returns whether Service Engine Condition Actions (SECAs) are disabled or not.
-     * @return
+     * @return returns whether Service Engine Condition Actions (SECAs) are disabled or not.
      * @throws GenericServiceException
      */
     public boolean isEcasDisabled();

Modified: ofbiz/trunk/framework/service/src/org/ofbiz/service/ModelService.java
URL: http://svn.apache.org/viewvc/ofbiz/trunk/framework/service/src/org/ofbiz/service/ModelService.java?rev=1126729&r1=1126728&r2=1126729&view=diff
==============================================================================
--- ofbiz/trunk/framework/service/src/org/ofbiz/service/ModelService.java (original)
+++ ofbiz/trunk/framework/service/src/org/ofbiz/service/ModelService.java Mon May 23 20:38:36 2011
@@ -475,8 +475,9 @@ public class ModelService extends Abstra
 
     /**
      * Validates a Map against the IN or OUT parameter information
-     * @param test The Map object to test
+     * @param context the context
      * @param mode Test either mode IN or mode OUT
+     * @param locale the actual locale to use
      */
     public void validate(Map<String, Object> context, String mode, Locale locale) throws ServiceValidationException {
         Map<String, String> requiredInfo = FastMap.newInstance();
@@ -833,7 +834,8 @@ public class ModelService extends Abstra
      * @param source The source map
      * @param mode The mode which to build the new map
      * @param includeInternal When false will exclude internal fields
-     * @param tz TimeZone to use to do some type conversion
+     * @param errorMessages the list of error messages
+     * @param timeZone TimeZone to use to do some type conversion
      * @param locale Locale to use to do some type conversion
      */
     public Map<String, Object> makeValid(Map<String, ? extends Object> source, String mode, boolean includeInternal, List<Object> errorMessages, TimeZone timeZone, Locale locale) {

Modified: ofbiz/trunk/framework/service/src/org/ofbiz/service/ServiceDispatcher.java
URL: http://svn.apache.org/viewvc/ofbiz/trunk/framework/service/src/org/ofbiz/service/ServiceDispatcher.java?rev=1126729&r1=1126728&r2=1126729&view=diff
==============================================================================
--- ofbiz/trunk/framework/service/src/org/ofbiz/service/ServiceDispatcher.java (original)
+++ ofbiz/trunk/framework/service/src/org/ofbiz/service/ServiceDispatcher.java Mon May 23 20:38:36 2011
@@ -243,7 +243,7 @@ public class ServiceDispatcher {
      * Run the service synchronously and return the result.
      * @param localName Name of the context to use.
      * @param modelService Service model object.
-     * @param context Map of name, value pairs composing the context.
+     * @param params Map of name, value pairs composing the parameters.
      * @param validateOut Validate OUT parameters
      * @return Map of name, value pairs composing the result.
      * @throws ServiceAuthException
@@ -618,7 +618,7 @@ public class ServiceDispatcher {
      * Run the service asynchronously, passing an instance of GenericRequester that will receive the result.
      * @param localName Name of the context to use.
      * @param service Service model object.
-     * @param context Map of name, value pairs composing the context.
+     * @param params Map of name, value pairs composing the parameters.
      * @param requester Object implementing GenericRequester interface which will receive the result.
      * @param persist True for store/run; False for run.
      * @throws ServiceAuthException

Modified: ofbiz/trunk/framework/service/src/org/ofbiz/service/calendar/ExpressionUiHelper.java
URL: http://svn.apache.org/viewvc/ofbiz/trunk/framework/service/src/org/ofbiz/service/calendar/ExpressionUiHelper.java?rev=1126729&r1=1126728&r2=1126729&view=diff
==============================================================================
--- ofbiz/trunk/framework/service/src/org/ofbiz/service/calendar/ExpressionUiHelper.java (original)
+++ ofbiz/trunk/framework/service/src/org/ofbiz/service/calendar/ExpressionUiHelper.java Mon May 23 20:38:36 2011
@@ -42,7 +42,7 @@ public class ExpressionUiHelper {
     public static final int Occurrence[] = {1, 2, 3, 4, 5, -1, -2, -3, -4 -5};
 
     /** Returns a List of valid DayInMonth occurrence int values.
-     * @return
+     * @return returns a List of valid DayInMonth occurrence int values
      */
     public static List<?> getOccurrenceList() {
         return Arrays.asList(Occurrence);

Modified: ofbiz/trunk/framework/service/src/org/ofbiz/service/calendar/TemporalExpressions.java
URL: http://svn.apache.org/viewvc/ofbiz/trunk/framework/service/src/org/ofbiz/service/calendar/TemporalExpressions.java?rev=1126729&r1=1126728&r2=1126729&view=diff
==============================================================================
--- ofbiz/trunk/framework/service/src/org/ofbiz/service/calendar/TemporalExpressions.java (original)
+++ ofbiz/trunk/framework/service/src/org/ofbiz/service/calendar/TemporalExpressions.java Mon May 23 20:38:36 2011
@@ -988,7 +988,7 @@ public class TemporalExpressions impleme
         protected final int start;
 
         /**
-         * @param hour An integer in the range of 0 to 59.
+         * @param minute An integer in the range of 0 to 59.
          */
         public MinuteRange(int minute) {
             this(minute, minute);

Modified: ofbiz/trunk/framework/service/src/org/ofbiz/service/engine/AbstractEngine.java
URL: http://svn.apache.org/viewvc/ofbiz/trunk/framework/service/src/org/ofbiz/service/engine/AbstractEngine.java?rev=1126729&r1=1126728&r2=1126729&view=diff
==============================================================================
--- ofbiz/trunk/framework/service/src/org/ofbiz/service/engine/AbstractEngine.java (original)
+++ ofbiz/trunk/framework/service/src/org/ofbiz/service/engine/AbstractEngine.java Mon May 23 20:38:36 2011
@@ -84,7 +84,7 @@ public abstract class AbstractEngine imp
     }
 
     /**
-     * @see org.ofbiz.service.engine.GenericEngine#sendCallbacks(org.ofbiz.service.ModelService, java.util.Map, java.lang.Object, int)
+     * @see org.ofbiz.service.engine.GenericEngine#sendCallbacks(org.ofbiz.service.ModelService, java.util.Map, int)
      */
     public void sendCallbacks(ModelService model, Map<String, Object> context, int mode) throws GenericServiceException {
         if (!allowCallbacks(model, context, mode)) return;

Modified: ofbiz/trunk/framework/service/src/org/ofbiz/service/engine/GenericEngine.java
URL: http://svn.apache.org/viewvc/ofbiz/trunk/framework/service/src/org/ofbiz/service/engine/GenericEngine.java?rev=1126729&r1=1126728&r2=1126729&view=diff
==============================================================================
--- ofbiz/trunk/framework/service/src/org/ofbiz/service/engine/GenericEngine.java (original)
+++ ofbiz/trunk/framework/service/src/org/ofbiz/service/engine/GenericEngine.java Mon May 23 20:38:36 2011
@@ -81,7 +81,6 @@ public interface GenericEngine {
      * Send the service callbacks
      * @param modelService Service model object
      * @param context Map of name, value pairs composing the context
-     * @param cbObj Object to return to callback (Throwable or Map)
      * @param mode Service mode (sync or async)
      * @throws GenericServiceException
      */

Modified: ofbiz/trunk/framework/service/src/org/ofbiz/service/jms/AbstractJmsListener.java
URL: http://svn.apache.org/viewvc/ofbiz/trunk/framework/service/src/org/ofbiz/service/jms/AbstractJmsListener.java?rev=1126729&r1=1126728&r2=1126729&view=diff
==============================================================================
--- ofbiz/trunk/framework/service/src/org/ofbiz/service/jms/AbstractJmsListener.java (original)
+++ ofbiz/trunk/framework/service/src/org/ofbiz/service/jms/AbstractJmsListener.java Mon May 23 20:38:36 2011
@@ -47,7 +47,7 @@ public abstract class AbstractJmsListene
 
     /**
      * Initializes the LocalDispatcher for this service listener.
-     * @param dispatcher
+     * @param serviceDispatcher the service dispatcher
      */
     protected AbstractJmsListener(ServiceDispatcher serviceDispatcher) {
         this.dispatcher = GenericDispatcher.getLocalDispatcher("entity-default", null, null, this.getClass().getClassLoader(), serviceDispatcher);

Modified: ofbiz/trunk/framework/service/src/org/ofbiz/service/test/ServiceEngineTestServices.java
URL: http://svn.apache.org/viewvc/ofbiz/trunk/framework/service/src/org/ofbiz/service/test/ServiceEngineTestServices.java?rev=1126729&r1=1126728&r2=1126729&view=diff
==============================================================================
--- ofbiz/trunk/framework/service/src/org/ofbiz/service/test/ServiceEngineTestServices.java (original)
+++ ofbiz/trunk/framework/service/src/org/ofbiz/service/test/ServiceEngineTestServices.java Mon May 23 20:38:36 2011
@@ -228,9 +228,9 @@ public class ServiceEngineTestServices {
      * current service run is complete, and AFTER it has committed or rolled back its transaction; if a service finds
      * it has a lock wait timeout, add itself to the list for its parent service (somehow...) and off we go!
      *
-     * @param dctx
-     * @param context
-     * @return
+     * @param dctx the dispatch context
+     * @param context the context
+     * @return returns the results of the service execution
      */
     public static Map<String, Object> testServiceLockWaitTimeoutRetryCantRecover(DispatchContext dctx, Map<String, ? extends Object> context) {
         Delegator delegator = dctx.getDelegator();