Changeset 3993


Ignore:
Timestamp:
Nov 22, 2007, 2:38:11 PM (14 years ago)
Author:
Martin Svensson
Message:

References #827 Updated some javadoc to the new methods.

Location:
trunk/src/webservices
Files:
2 edited

Legend:

Unmodified
Added
Removed
  • trunk/src/webservices/client/java/net/sf/basedb/ws/client/ReporterClient.java

    r3991 r3993  
    7373      @param reporterListId Id of the reporter list to export and download.
    7474      @param extPropInfo An array of ExtendedPropertyInfo objects to include in the export/download.
     75      @param qOpt QueryOptions to use when selecting items from the database.
    7576      @return InputStream object to the exported data.
    7677      @throws IOException If something goes wrong with the input stream
     
    9495  }
    9596 
     97  /**
     98    Downloads exported reporter properties to an input stream.
     99      @param extPropInfo A list with the extended properties to export.
     100      @param qOpt Options on the query that selects data from the database.
     101      @return An input stream to a text file.
     102      @throws IOException If something goes wrong when getting the exported properties.
     103   */
    96104  public InputStream downloadReporters(ExtendedPropertyInfo[] extPropInfo, QueryOptions qOpt)
    97105    throws IOException
  • trunk/src/webservices/server/net/sf/basedb/ws/server/ReporterService.java

    r3991 r3993  
    5454
    5555/**
    56   Services for Reporters in Base.
     56  Services for Reporters in Base.
     57  Information about reporters can only be accessed by downloading it in a file first.
     58  This service provide two methods to download reporters in a file, {@link #downloadReporters(String, ExtendedPropertyInfo[], QueryOptions)}
     59  or {@link #downloadReportersInList(String, int, ExtendedPropertyInfo[], QueryOptions)}
    5760    @author Martin
    5861  @since 2.5
     
    6164  extends AbstractRPCService
    6265{
     66  /**
     67    Empty constructor
     68   */
    6369  public ReporterService()
    6470  {}
     
    8692      @param reporterListId Id of the reporter list to download reporters information from.
    8793      @param extPropInfos The extended property to include in the download.
     94      @param qOpt Query options to set on the query that select data from the database.
    8895      @return java.io.InputStream object to the exported data.
    8996      @throws Exception If something goes wrong with the export.
     
    145152  }
    146153 
     154  /**
     155    Attach a file with exported reporter properties so it can be send through web services.   
     156      @param ID The id of an active session. Used to verify the logged in user and it's permissions.
     157      @param extPropInfos A list with the extended properties to export.
     158        A reporters name, external id and reporter type are always exported.
     159      @param qOpt Options to use on the query that select data.
     160      @return An OMElement to return through web services.
     161      @throws Exception If anything goes wrong with the export.
     162   */
    147163  public OMElement downloadReporters(String ID, ExtendedPropertyInfo[] extPropInfos, QueryOptions qOpt)
    148164    throws Exception
Note: See TracChangeset for help on using the changeset viewer.