net.sf.basedb.ws.server
Class ReporterService

java.lang.Object
  net.sf.basedb.ws.server.AbstractRPCService
      net.sf.basedb.ws.server.ReporterService

public class ReporterService
extends AbstractRPCService

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, downloadReporters(String, ExtendedPropertyInfo[], QueryOptions) or downloadReportersInList(String, int, ExtendedPropertyInfo[], QueryOptions)

Since:

2.5

Author:

Martin

Field Summary

Fields inherited from class net.sf.basedb.ws.server.AbstractRPCService

util

Constructor Summary

ReporterService()
Empty constructor

Method Summary

private ExportedProperty	createExportedProperty(String path, String title, Metadata metadata, Formatter formatter)
org.apache.axiom.om.OMElement	downloadReporters(String ID, ExtendedPropertyInfo[] extPropInfos, QueryOptions qOpt) Attach a file with exported reporter properties so it can be send through web services.
org.apache.axiom.om.OMElement	downloadReportersInList(String ID, int reporterListId, ExtendedPropertyInfo[] extPropInfos, QueryOptions qOpt) Gets an input stream to exported data from a reporter list.
ExtendedPropertyInfo[]	getExtendedProperties() Gets information about each extended property for reporters.

Methods inherited from class net.sf.basedb.ws.server.AbstractRPCService

attachFile, getRemoteId, getSessionControl

Methods inherited from class java.lang.Object

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

Constructor Detail

ReporterService

public ReporterService()

Empty constructor

Method Detail

getExtendedProperties

public ExtendedPropertyInfo[] getExtendedProperties()

Gets information about each extended property for reporters.

Returns:

an ExtendedPropertyInfo array.

downloadReportersInList

public org.apache.axiom.om.OMElement downloadReportersInList(String ID,
                                                             int reporterListId,
                                                             ExtendedPropertyInfo[] extPropInfos,
                                                             QueryOptions qOpt)
                                                      throws Exception

Gets an input stream to exported data from a reporter list.

Parameters:

ID - Id of an active session.

reporterListId - Id of the reporter list to download reporters information from.

extPropInfos - The extended property to include in the download.

qOpt - Query options to set on the query that select data from the database.

Returns:

java.io.InputStream object to the exported data.

Throws:

Exception - If something goes wrong with the export.

downloadReporters

public org.apache.axiom.om.OMElement downloadReporters(String ID,
                                                       ExtendedPropertyInfo[] extPropInfos,
                                                       QueryOptions qOpt)
                                                throws Exception

Attach a file with exported reporter properties so it can be send through web services.

Parameters:

ID - The id of an active session. Used to verify the logged in user and it's permissions.

extPropInfos - A list with the extended properties to export. A reporters name, external id and reporter type are always exported.

qOpt - Options to use on the query that select data.

Returns:

An OMElement to return through web services.

Throws:

Exception - If anything goes wrong with the export.

createExportedProperty

private ExportedProperty createExportedProperty(String path,
                                                String title,
                                                Metadata metadata,
                                                Formatter formatter)