net.sf.basedb.ws.client
Class ReporterClient

java.lang.Object
  net.sf.basedb.ws.client.AbstractRPCClient
      net.sf.basedb.ws.client.ReporterClient

public class ReporterClient
extends AbstractRPCClient

Web service client for reporter.

Since:

2.5

Author:

Martin

Field Summary

private SessionClient

session

Constructor Summary

ReporterClient(SessionClient session)
Creates a new instance of ReporterClient used together with a SessionClient

Method Summary

InputStream	downloadReporters(ExtendedPropertyInfo[] extPropInfo, QueryOptions qOpt) Downloads exported reporter properties to an input stream.
InputStream	downloadReportersInList(int reporterListId, ExtendedPropertyInfo[] extPropInfo, QueryOptions qOpt) Gets an input stream for a file with info about reporters in a reporter list.
ExtendedPropertyInfo[]	getExtendedProperties() Gets the extended properties, for reporters, through web services.

Methods inherited from class net.sf.basedb.ws.client.AbstractRPCClient

getOperation, getService, getServiceFactory, invokeBlocking, invokeBlocking, invokeBlocking, invokeFileBlocking, setServiceFactory

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

session

private SessionClient session

Constructor Detail

ReporterClient

public ReporterClient(SessionClient session)

Creates a new instance of ReporterClient used together with a SessionClient

Parameters:

session - The SessionClient to use.

Method Detail

getExtendedProperties

public ExtendedPropertyInfo[] getExtendedProperties()
                                             throws org.apache.axis2.AxisFault

Gets the extended properties, for reporters, through web services.

Returns:

An array with ExtendedPropertyInfo

Throws:

org.apache.axis2.AxisFault

downloadReportersInList

public InputStream downloadReportersInList(int reporterListId,
                                           ExtendedPropertyInfo[] extPropInfo,
                                           QueryOptions qOpt)
                                    throws IOException

Gets an input stream for a file with info about reporters in a reporter list.

Parameters:

reporterListId - Id of the reporter list to export and download.

extPropInfo - An array of ExtendedPropertyInfo objects to include in the export/download.

qOpt - QueryOptions to use when selecting items from the database.

Returns:

InputStream object to the exported data.

Throws:

IOException - If something goes wrong with the input stream

downloadReporters

public InputStream downloadReporters(ExtendedPropertyInfo[] extPropInfo,
                                     QueryOptions qOpt)
                              throws IOException

Downloads exported reporter properties to an input stream.

Parameters:

extPropInfo - A list with the extended properties to export.

qOpt - Options on the query that selects data from the database.

Returns:

An input stream to a text file.

Throws:

IOException - If something goes wrong when getting the exported properties.