net.sf.basedb.ws.client
Class ExperimentClient

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

public class ExperimentClient
extends AbstractRPCClient

Webservice client for Experiment. Call services in ExperimentService

Version:

2.5

Author:

Martin

Field Summary

private SessionClient

session

Constructor Summary

ExperimentClient(SessionClient session)
Creates a new client in active session

Method Summary

BioAssaySetInfo[]	getBioAssaySets(int experimentId, QueryOptions qOpt) Gets info about bioassay sets in an experiment
ExperimentInfo	getById(int itemId) Get info about an experiment when you know the ID.
AnnotationTypeInfo[]	getExperimentalFactors(int experimentId, QueryOptions qOpt) Gets info about the experimental factors for an experiment.
ExperimentInfo[]	getExperiments(QueryOptions qOpt) Gets info about experiments that are available in the logged in session.
RawBioAssayInfo[]	getRawBioAssays(int experimentId, QueryOptions qOpt) Gets info about raw bioassays used in an experiment.
ReporterListInfo[]	getReporterLists(int experimentId, QueryOptions qOpt) Gets info about reporter lists in an experiment.

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 final SessionClient session

Constructor Detail

ExperimentClient

public ExperimentClient(SessionClient session)

Creates a new client in active session

Parameters:

session - The active session

Method Detail

getById

public ExperimentInfo getById(int itemId)
                       throws org.apache.axis2.AxisFault

Get info about an experiment when you know the ID.

Parameters:

itemId - The ID of the experiment

Returns:

An ExperimentInfo object

Throws:

org.apache.axis2.AxisFault - If communication with web service fails.

getExperiments

public ExperimentInfo[] getExperiments(QueryOptions qOpt)
                                throws org.apache.axis2.AxisFault

Gets info about experiments that are available in the logged in session.

Parameters:

qOpt - Options to put on the query that gets the experiments.

Returns:

An array with info object for each experiment that was found.

Throws:

org.apache.axis2.AxisFault - If communication with web service fails.

getRawBioAssays

public RawBioAssayInfo[] getRawBioAssays(int experimentId,
                                         QueryOptions qOpt)
                                  throws org.apache.axis2.AxisFault

Gets info about raw bioassays used in an experiment.

Parameters:

experimentId - Id of experiment to get raw bioassays from.

qOpt - Options to put on the query that gets the raw bioassays.

Returns:

An array with info object about each raw bioassay that was found.

Throws:

org.apache.axis2.AxisFault - If communication with web services fails.

getBioAssaySets

public BioAssaySetInfo[] getBioAssaySets(int experimentId,
                                         QueryOptions qOpt)
                                  throws org.apache.axis2.AxisFault

Gets info about bioassay sets in an experiment

Parameters:

experimentId - Id of the experiment to get the bioassay sets from

qOpt - Options to put on the query that gets the bioassay sets.

Returns:

An array with info about each bioassay set found by the query.

Throws:

org.apache.axis2.AxisFault - If communication with web services fails.

getExperimentalFactors

public AnnotationTypeInfo[] getExperimentalFactors(int experimentId,
                                                   QueryOptions qOpt)
                                            throws org.apache.axis2.AxisFault

Gets info about the experimental factors for an experiment.

Parameters:

experimentId - Id of experiment to get experimental factors from

qOpt - Options to put on the query

Returns:

An array with info object about each annotation type that was found

Throws:

org.apache.axis2.AxisFault - If communication with web services fails.

getReporterLists

public ReporterListInfo[] getReporterLists(int experimentId,
                                           QueryOptions qOpt)
                                    throws org.apache.axis2.AxisFault

Gets info about reporter lists in an experiment.

Parameters:

experimentId - Id of the experiment the lists are used in

qOpt - Options to put on the query that gets the reporter lists.

Returns:

An array with info about each reporter list.

Throws:

org.apache.axis2.AxisFault - If communication with web services fails.