← Back to team overview

dhis2-devs team mailing list archive

[Branch ~dhis2-devs-core/dhis2/trunk] Rev 20411: minor jsdoc/parameter cleanup

 

------------------------------------------------------------
revno: 20411
committer: Morten Olav Hansen <mortenoh@xxxxxxxxx>
branch nick: dhis2
timestamp: Wed 2015-09-30 13:53:21 +0700
message:
  minor jsdoc/parameter cleanup
modified:
  dhis-2/dhis-api/src/main/java/org/hisp/dhis/trackedentity/TrackedEntityAttributeService.java
  dhis-2/dhis-services/dhis-service-core/src/main/java/org/hisp/dhis/trackedentity/DefaultTrackedEntityAttributeService.java


--
lp:dhis2
https://code.launchpad.net/~dhis2-devs-core/dhis2/trunk

Your team DHIS 2 developers is subscribed to branch lp:dhis2.
To unsubscribe from this branch go to https://code.launchpad.net/~dhis2-devs-core/dhis2/trunk/+edit-subscription
=== modified file 'dhis-2/dhis-api/src/main/java/org/hisp/dhis/trackedentity/TrackedEntityAttributeService.java'
--- dhis-2/dhis-api/src/main/java/org/hisp/dhis/trackedentity/TrackedEntityAttributeService.java	2015-09-30 06:22:47 +0000
+++ dhis-2/dhis-api/src/main/java/org/hisp/dhis/trackedentity/TrackedEntityAttributeService.java	2015-09-30 06:53:21 +0000
@@ -101,9 +101,8 @@
     /**
      * Returns a {@link TrackedEntityAttribute} with a given code.
      *
-     * @param name the code of the TrackedEntityAttribute to return.
-     * @return the TrackedEntityAttribute with the given code, or null if no
-     * match.
+     * @param code The code of the TrackedEntityAttribute to return.
+     * @return the TrackedEntityAttribute with the given code, or null if no match.
      */
     TrackedEntityAttribute getTrackedEntityAttributeByCode( String code );
 
@@ -141,7 +140,6 @@
     /**
      * Get attributes which are displayed in visit schedule
      *
-     * @param displayInListNoProgram True/False value
      * @return List of attributes
      */
     List<TrackedEntityAttribute> getTrackedEntityAttributesWithoutProgram();
@@ -149,7 +147,6 @@
     /**
      * Get attributes which are displayed in visit schedule
      *
-     * @param displayInListNoProgram True/False value
      * @return List of attributes
      */
     List<TrackedEntityAttribute> getTrackedEntityAttributesDisplayInList();
@@ -157,13 +154,13 @@
     /**
      * Returns {@link TrackedEntityAttribute} list with paging
      *
-     * @param name Keyword for searching by name
-     * @param min
-     * @param max
+     * @param name   Keyword for searching by name
+     * @param offset Offset to start results collection from
+     * @param max    Maximum number of results
      * @return a collection of all TrackedEntityAttribute, or an empty
      * collection if there are no TrackedEntityAttributes.
      */
-    List<TrackedEntityAttribute> getTrackedEntityAttributesBetweenByName( String name, int min, int max );
+    List<TrackedEntityAttribute> getTrackedEntityAttributesBetweenByName( String name, int offset, int max );
 
     /**
      * Returns The number of all TrackedEntityAttribute available
@@ -173,12 +170,12 @@
     /**
      * Returns {@link TrackedEntityAttribute} list with paging
      *
-     * @param min
-     * @param max
+     * @param offset Offset to start results collection from
+     * @param max    Maximum number of results
      * @return a collection of all TrackedEntityAttribute, or an empty
      * collection if there are no TrackedEntityAttributes.
      */
-    List<TrackedEntityAttribute> getTrackedEntityAttributesBetween( int min, int max );
+    List<TrackedEntityAttribute> getTrackedEntityAttributesBetween( int offset, int max );
 
     /**
      * Returns The number of TrackedEntityAttributes with the key searched

=== modified file 'dhis-2/dhis-services/dhis-service-core/src/main/java/org/hisp/dhis/trackedentity/DefaultTrackedEntityAttributeService.java'
--- dhis-2/dhis-services/dhis-service-core/src/main/java/org/hisp/dhis/trackedentity/DefaultTrackedEntityAttributeService.java	2015-09-30 06:41:12 +0000
+++ dhis-2/dhis-services/dhis-service-core/src/main/java/org/hisp/dhis/trackedentity/DefaultTrackedEntityAttributeService.java	2015-09-30 06:53:21 +0000
@@ -176,9 +176,9 @@
     }
 
     @Override
-    public List<TrackedEntityAttribute> getTrackedEntityAttributesBetweenByName( String name, int min, int max )
+    public List<TrackedEntityAttribute> getTrackedEntityAttributesBetweenByName( String name, int offset, int max )
     {
-        return attributeStore.getAllLikeName( name, min, max );
+        return attributeStore.getAllLikeName( name, offset, max );
     }
 
     @Override
@@ -188,9 +188,9 @@
     }
 
     @Override
-    public List<TrackedEntityAttribute> getTrackedEntityAttributesBetween( int min, int max )
+    public List<TrackedEntityAttribute> getTrackedEntityAttributesBetween( int offset, int max )
     {
-        return attributeStore.getAllOrderedName( min, max );
+        return attributeStore.getAllOrderedName( offset, max );
     }
 
     @Override