Changeset 3993

Timestamp:

Nov 22, 2007, 2:38:11 PM (16 years ago)

Author:

Martin Svensson

Message:

References #827 Updated some javadoc to the new methods.

Location:

trunk/src/webservices

Files:

• client/java/net/sf/basedb/ws/client/ReporterClient.java (modified) (2 diffs)
• server/net/sf/basedb/ws/server/ReporterService.java (modified) (4 diffs)

trunk/src/webservices/client/java/net/sf/basedb/ws/client/ReporterClient.java

@@ -73 +73 @@
       @param reporterListId Id of the reporter list to export and download.
       @param extPropInfo An array of ExtendedPropertyInfo objects to include in the export/download.
+      @param qOpt QueryOptions to use when selecting items from the database.
       @return InputStream object to the exported data.
       @throws IOException If something goes wrong with the input stream
@@ -94 +95 @@
   }
   
+  /**
+    Downloads exported reporter properties to an input stream. 
+      @param extPropInfo A list with the extended properties to export.
+      @param qOpt Options on the query that selects data from the database.
+      @return An input stream to a text file.
+      @throws IOException If something goes wrong when getting the exported properties.
+   */
   public InputStream downloadReporters(ExtendedPropertyInfo[] extPropInfo, QueryOptions qOpt)
     throws IOException

trunk/src/webservices/server/net/sf/basedb/ws/server/ReporterService.java

@@ -54 +54 @@
 
 /**
-  Services for Reporters in Base.
+  Services for Reporters in Base. 
+  Information about reporters can only be accessed by downloading it in a file first.
+  This service provide two methods to download reporters in a file, {@link #downloadReporters(String, ExtendedPropertyInfo[], QueryOptions)}
+  or {@link #downloadReportersInList(String, int, ExtendedPropertyInfo[], QueryOptions)} 
     @author Martin
   @since 2.5
@@ -61 +64 @@
   extends AbstractRPCService
 {
+  /**
+    Empty constructor
+   */
   public ReporterService()
   {}
@@ -86 +92 @@
       @param reporterListId Id of the reporter list to download reporters information from.
       @param extPropInfos The extended property to include in the download.
+      @param qOpt Query options to set on the query that select data from the database.
       @return java.io.InputStream object to the exported data.
       @throws Exception If something goes wrong with the export.
@@ -145 +152 @@
   }
   
+  /**
+    Attach a file with exported reporter properties so it can be send through web services.   
+      @param ID The id of an active session. Used to verify the logged in user and it's permissions.
+      @param extPropInfos A list with the extended properties to export. 
+        A reporters name, external id and reporter type are always exported.
+      @param qOpt Options to use on the query that select data.
+      @return An OMElement to return through web services.
+      @throws Exception If anything goes wrong with the export.
+   */
   public OMElement downloadReporters(String ID, ExtendedPropertyInfo[] extPropInfos, QueryOptions qOpt)
     throws Exception