net.sf.basedb.ws.server
Class ExperimentService

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

public class ExperimentService
extends AbstractRPCService

Web Service class for Experiment

Version:

2.5

Author:

Nicklas, Martin

Field Summary

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

util

Constructor Summary

ExperimentService()

Method Summary

BioAssaySetInfo[]	getBioAssaySets(String ID, int experimentId, QueryOptions qOpt) Gets information about the bioassay sets in an experiment.
ExperimentInfo	getById(String ID, int itemId) Get information about an experiment that you know the ID of.
AnnotationTypeInfo[]	getExperimentalFactors(String ID, int experimentId, QueryOptions qOpt) Gets an array with information objects for each experimental factor in an experiment.
ExperimentInfo[]	getExperiments(String ID, QueryOptions qOpt) Gets an array with info about experiments available for the active session.
RawBioAssayInfo[]	getRawBioAssays(String ID, int experimentId, QueryOptions qOpt) Gets an array with information objects for each rawbioassay in an experiment.
ReporterListInfo[]	getReporterLists(String ID, int experimentId, QueryOptions qOpt) Gets an array with information objects for each reporter list used in an Experiment.

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

ExperimentService

public ExperimentService()

Method Detail

getById

public ExperimentInfo getById(String ID,
                              int itemId)

Get information about an experiment that you know the ID of.

Parameters:

ID - Id to identify the session.

itemId - The ID of the experiment

Returns:

The experiment information

getExperiments

public ExperimentInfo[] getExperiments(String ID,
                                       QueryOptions qOpt)

Gets an array with info about experiments available for the active session.

Parameters:

ID - Id for the session to use.

qOpt - QueryOptions to put on the query that gets the Experiments.

Returns:

An ExperimentInfo array.

getBioAssaySets

public BioAssaySetInfo[] getBioAssaySets(String ID,
                                         int experimentId,
                                         QueryOptions qOpt)

Gets information about the bioassay sets in an experiment. The caller of this method can put restriction on the query that gets the bioassay sets.

Parameters:

ID - Id to identify the active session with

experimentId - Id of the experiment the bioassay sets are in.

qOpt - Includes and restrictions to put on query that gets the bioassay sets.

Returns:

Array of ItemInfo:s, one for each bioassay set that where found by the query.

getRawBioAssays

public RawBioAssayInfo[] getRawBioAssays(String ID,
                                         int experimentId,
                                         QueryOptions qOpt)

Gets an array with information objects for each rawbioassay in an experiment.

Parameters:

ID - The id to identify an active session.

experimentId - The id of the experiment to get the rawbioassays from.

qOpt - QueryOptions to put on the query when getting the rawbioassays.

Returns:

Array with RawBioAssayInfos

getReporterLists

public ReporterListInfo[] getReporterLists(String ID,
                                           int experimentId,
                                           QueryOptions qOpt)

Gets an array with information objects for each reporter list used in an Experiment.

Parameters:

ID - The id to identify an active session.

experimentId - The id of the experiment to get the reporter lists from.

qOpt - QueryOptions to put on the query when getting the reporter lists.

Returns:

ReporterListInfo array.

getExperimentalFactors

public AnnotationTypeInfo[] getExperimentalFactors(String ID,
                                                   int experimentId,
                                                   QueryOptions qOpt)

Gets an array with information objects for each experimental factor in an experiment.

Parameters:

ID - The id to identify an active session.

experimentId - The id of the experiment to get the rawbioassays from.

qOpt - QueryOptions to put on the query

Returns:

Array with AnnotationTypeInfo:s