gov.nih.nci.caarray.services.external.v1_0.grid.common
Interface CaArraySvc_v1_0I

All Known Implementing Classes:
CaArraySvc_v1_0Client

public interface CaArraySvc_v1_0I

This class is autogenerated, DO NOT EDIT. This interface represents the API which is accessable on the grid service from the client.


Method Summary
 gov.nih.nci.cagrid.enumeration.stubs.response.EnumerationResponseContainer enumerateBiomaterials(BiomaterialSearchCriteria criteria)
           
 gov.nih.nci.cagrid.enumeration.stubs.response.EnumerationResponseContainer enumerateBiomaterialsByKeyword(BiomaterialKeywordSearchCriteria criteria)
           
 gov.nih.nci.cagrid.enumeration.stubs.response.EnumerationResponseContainer enumerateByExample(ExampleSearchCriteria criteria)
           
 gov.nih.nci.cagrid.enumeration.stubs.response.EnumerationResponseContainer enumerateExperiments(ExperimentSearchCriteria experimentSearchCriteria)
          Begin an enumeration of experiments matching given criteria
 gov.nih.nci.cagrid.enumeration.stubs.response.EnumerationResponseContainer enumerateExperimentsByKeyword(KeywordSearchCriteria criteria)
           
 gov.nih.nci.cagrid.enumeration.stubs.response.EnumerationResponseContainer enumerateFiles(FileSearchCriteria criteria)
           
 gov.nih.nci.cagrid.enumeration.stubs.response.EnumerationResponseContainer enumerateHybridizations(HybridizationSearchCriteria criteria)
           
 Category[] getAllCharacteristicCategories(CaArrayEntityReference experimentRef)
           
 Person[] getAllPrincipalInvestigators()
          return list of all persons who are principal investigators for some experiment
 AnnotationSet getAnnotationSet(AnnotationSetRequest request)
           
 DataSet getDataSet(DataSetRequest dataSetRequest)
          Retrieves a parsed data set
 org.cagrid.transfer.context.stubs.types.TransferServiceContextReference getFileContentsTransfer(CaArrayEntityReference fileRef, boolean compress)
          Returns a grid transfer reference for retrieving the given reference
 MageTabFileSet getMageTabExport(CaArrayEntityReference experimentRef)
          Returns an export of an experiment as a set of mage-tab IDF and SDRF, along with metadata for associated data files
 org.oasis.wsrf.properties.GetMultipleResourcePropertiesResponse getMultipleResourceProperties(org.oasis.wsrf.properties.GetMultipleResourceProperties_Element params)
           
 org.oasis.wsrf.properties.GetResourcePropertyResponse getResourceProperty(javax.xml.namespace.QName params)
           
 Term[] getTermsForCategory(CaArrayEntityReference categoryRef, java.lang.String valuePrefix)
           
 org.oasis.wsrf.properties.QueryResourcePropertiesResponse queryResourceProperties(org.oasis.wsrf.properties.QueryResourceProperties_Element params)
           
 SearchResult searchByExample(ExampleSearchCriteria criteria, LimitOffset limitOffset)
          Search using an entity as example
 SearchResult searchForBiomaterials(BiomaterialSearchCriteria criteria, LimitOffset limitOffset)
          search for biomaterials matching criteria
 SearchResult searchForBiomaterialsByKeyword(BiomaterialKeywordSearchCriteria criteria, LimitOffset limitOffset)
          Search for biomaterials matching given keyword
 SearchResult searchForExperiments(ExperimentSearchCriteria criteria, LimitOffset limitOffset)
          Search for experiments matching given criteria
 SearchResult searchForExperimentsByKeyword(KeywordSearchCriteria criteria, LimitOffset limitOffset)
          Searches for experiments using a keyword search across fields
 SearchResult searchForFiles(FileSearchCriteria criteria, LimitOffset limitOffset)
          Search for files matching given criteria
 SearchResult searchForHybridizations(HybridizationSearchCriteria criteria, LimitOffset limitOffset)
          search for hybridizations matching criteria
 QuantitationType[] searchForQuantitationTypes(QuantitationTypeSearchCriteria criteria)
          Search for quantitation types matching criteria
 

Method Detail

searchForExperiments

SearchResult searchForExperiments(ExperimentSearchCriteria criteria,
                                  LimitOffset limitOffset)
                                  throws java.rmi.RemoteException,
                                         gov.nih.nci.caarray.services.external.v1_0.grid.stubs.types.UnsupportedCategoryFault,
                                         gov.nih.nci.caarray.services.external.v1_0.grid.stubs.types.IncorrectEntityTypeFault,
                                         gov.nih.nci.caarray.services.external.v1_0.grid.stubs.types.NoEntityMatchingReferenceFault
Search for experiments matching given criteria

Parameters:
criteria -
limitOffset -
Throws:
UnsupportedCategoryFault
IncorrectEntityTypeFault
NoEntityMatchingReferenceFault
java.rmi.RemoteException

getAllPrincipalInvestigators

Person[] getAllPrincipalInvestigators()
                                      throws java.rmi.RemoteException
return list of all persons who are principal investigators for some experiment

Throws:
java.rmi.RemoteException

enumerateExperiments

gov.nih.nci.cagrid.enumeration.stubs.response.EnumerationResponseContainer enumerateExperiments(ExperimentSearchCriteria experimentSearchCriteria)
                                                                                                throws java.rmi.RemoteException
Begin an enumeration of experiments matching given criteria

Parameters:
experimentSearchCriteria -
Throws:
java.rmi.RemoteException

getFileContentsTransfer

org.cagrid.transfer.context.stubs.types.TransferServiceContextReference getFileContentsTransfer(CaArrayEntityReference fileRef,
                                                                                                boolean compress)
                                                                                                throws java.rmi.RemoteException,
                                                                                                       gov.nih.nci.caarray.services.external.v1_0.grid.stubs.types.IncorrectEntityTypeFault,
                                                                                                       gov.nih.nci.caarray.services.external.v1_0.grid.stubs.types.NoEntityMatchingReferenceFault,
                                                                                                       gov.nih.nci.caarray.services.external.v1_0.grid.stubs.types.DataStagingFault
Returns a grid transfer reference for retrieving the given reference

Parameters:
fileRef -
compress -
Throws:
IncorrectEntityTypeFault
NoEntityMatchingReferenceFault
DataStagingFault
java.rmi.RemoteException

getDataSet

DataSet getDataSet(DataSetRequest dataSetRequest)
                   throws java.rmi.RemoteException,
                          gov.nih.nci.caarray.services.external.v1_0.grid.stubs.types.InconsistentDataSetsFault,
                          gov.nih.nci.caarray.services.external.v1_0.grid.stubs.types.NoEntityMatchingReferenceFault,
                          gov.nih.nci.caarray.services.external.v1_0.grid.stubs.types.IncorrectEntityTypeFault
Retrieves a parsed data set

Parameters:
dataSetRequest - a DataSetRequest identifying the parsed data to be retrieved. The request must specify at least one hybridization or one file, and at least one quantitation type
Returns:
the data set
Throws:
InconsistentDataSetsFault - if the data sets for the hybridizations and/or files in the request are not consistent, e.g. do not correspond to the same design element list.
NoEntityMatchingReferenceFault - if any of the hybridization, file or quantitation references in the dataSetRequest are not valid
IncorrectEntityTypeFault - if any of the hybridization, file or quantitation references in the dataSetRequest are not valid
java.rmi.RemoteException

searchForBiomaterials

SearchResult searchForBiomaterials(BiomaterialSearchCriteria criteria,
                                   LimitOffset limitOffset)
                                   throws java.rmi.RemoteException,
                                          gov.nih.nci.caarray.services.external.v1_0.grid.stubs.types.IncorrectEntityTypeFault,
                                          gov.nih.nci.caarray.services.external.v1_0.grid.stubs.types.NoEntityMatchingReferenceFault,
                                          gov.nih.nci.caarray.services.external.v1_0.grid.stubs.types.UnsupportedCategoryFault
search for biomaterials matching criteria

Parameters:
criteria -
limitOffset -
Throws:
IncorrectEntityTypeFault
NoEntityMatchingReferenceFault
UnsupportedCategoryFault
java.rmi.RemoteException

searchForHybridizations

SearchResult searchForHybridizations(HybridizationSearchCriteria criteria,
                                     LimitOffset limitOffset)
                                     throws java.rmi.RemoteException,
                                            gov.nih.nci.caarray.services.external.v1_0.grid.stubs.types.IncorrectEntityTypeFault,
                                            gov.nih.nci.caarray.services.external.v1_0.grid.stubs.types.NoEntityMatchingReferenceFault
search for hybridizations matching criteria

Parameters:
criteria -
limitOffset -
Throws:
IncorrectEntityTypeFault
NoEntityMatchingReferenceFault
java.rmi.RemoteException

searchForExperimentsByKeyword

SearchResult searchForExperimentsByKeyword(KeywordSearchCriteria criteria,
                                           LimitOffset limitOffset)
                                           throws java.rmi.RemoteException
Searches for experiments using a keyword search across fields

Parameters:
criteria -
limitOffset -
Throws:
java.rmi.RemoteException

searchForFiles

SearchResult searchForFiles(FileSearchCriteria criteria,
                            LimitOffset limitOffset)
                            throws java.rmi.RemoteException,
                                   gov.nih.nci.caarray.services.external.v1_0.grid.stubs.types.IncorrectEntityTypeFault,
                                   gov.nih.nci.caarray.services.external.v1_0.grid.stubs.types.NoEntityMatchingReferenceFault
Search for files matching given criteria

Parameters:
criteria -
limitOffset -
Throws:
IncorrectEntityTypeFault
NoEntityMatchingReferenceFault
java.rmi.RemoteException

searchForBiomaterialsByKeyword

SearchResult searchForBiomaterialsByKeyword(BiomaterialKeywordSearchCriteria criteria,
                                            LimitOffset limitOffset)
                                            throws java.rmi.RemoteException
Search for biomaterials matching given keyword

Parameters:
criteria -
limitOffset -
Throws:
java.rmi.RemoteException

getMageTabExport

MageTabFileSet getMageTabExport(CaArrayEntityReference experimentRef)
                                throws java.rmi.RemoteException,
                                       gov.nih.nci.caarray.services.external.v1_0.grid.stubs.types.IncorrectEntityTypeFault,
                                       gov.nih.nci.caarray.services.external.v1_0.grid.stubs.types.NoEntityMatchingReferenceFault,
                                       gov.nih.nci.caarray.services.external.v1_0.grid.stubs.types.DataStagingFault
Returns an export of an experiment as a set of mage-tab IDF and SDRF, along with metadata for associated data files

Parameters:
experimentRef -
Throws:
IncorrectEntityTypeFault
NoEntityMatchingReferenceFault
DataStagingFault
java.rmi.RemoteException

searchForQuantitationTypes

QuantitationType[] searchForQuantitationTypes(QuantitationTypeSearchCriteria criteria)
                                              throws java.rmi.RemoteException,
                                                     gov.nih.nci.caarray.services.external.v1_0.grid.stubs.types.IncorrectEntityTypeFault,
                                                     gov.nih.nci.caarray.services.external.v1_0.grid.stubs.types.NoEntityMatchingReferenceFault
Search for quantitation types matching criteria

Parameters:
criteria -
Throws:
IncorrectEntityTypeFault
NoEntityMatchingReferenceFault
java.rmi.RemoteException

searchByExample

SearchResult searchByExample(ExampleSearchCriteria criteria,
                             LimitOffset limitOffset)
                             throws java.rmi.RemoteException
Search using an entity as example

Parameters:
criteria -
limitOffset -
Throws:
java.rmi.RemoteException

getAnnotationSet

AnnotationSet getAnnotationSet(AnnotationSetRequest request)
                               throws java.rmi.RemoteException,
                                      gov.nih.nci.caarray.services.external.v1_0.grid.stubs.types.IncorrectEntityTypeFault,
                                      gov.nih.nci.caarray.services.external.v1_0.grid.stubs.types.NoEntityMatchingReferenceFault
Throws:
java.rmi.RemoteException
gov.nih.nci.caarray.services.external.v1_0.grid.stubs.types.IncorrectEntityTypeFault
gov.nih.nci.caarray.services.external.v1_0.grid.stubs.types.NoEntityMatchingReferenceFault

getTermsForCategory

Term[] getTermsForCategory(CaArrayEntityReference categoryRef,
                           java.lang.String valuePrefix)
                           throws java.rmi.RemoteException,
                                  gov.nih.nci.caarray.services.external.v1_0.grid.stubs.types.IncorrectEntityTypeFault,
                                  gov.nih.nci.caarray.services.external.v1_0.grid.stubs.types.NoEntityMatchingReferenceFault
Throws:
java.rmi.RemoteException
gov.nih.nci.caarray.services.external.v1_0.grid.stubs.types.IncorrectEntityTypeFault
gov.nih.nci.caarray.services.external.v1_0.grid.stubs.types.NoEntityMatchingReferenceFault

getAllCharacteristicCategories

Category[] getAllCharacteristicCategories(CaArrayEntityReference experimentRef)
                                          throws java.rmi.RemoteException,
                                                 gov.nih.nci.caarray.services.external.v1_0.grid.stubs.types.NoEntityMatchingReferenceFault,
                                                 gov.nih.nci.caarray.services.external.v1_0.grid.stubs.types.IncorrectEntityTypeFault
Throws:
java.rmi.RemoteException
gov.nih.nci.caarray.services.external.v1_0.grid.stubs.types.NoEntityMatchingReferenceFault
gov.nih.nci.caarray.services.external.v1_0.grid.stubs.types.IncorrectEntityTypeFault

enumerateExperimentsByKeyword

gov.nih.nci.cagrid.enumeration.stubs.response.EnumerationResponseContainer enumerateExperimentsByKeyword(KeywordSearchCriteria criteria)
                                                                                                         throws java.rmi.RemoteException
Throws:
java.rmi.RemoteException

enumerateBiomaterials

gov.nih.nci.cagrid.enumeration.stubs.response.EnumerationResponseContainer enumerateBiomaterials(BiomaterialSearchCriteria criteria)
                                                                                                 throws java.rmi.RemoteException
Throws:
java.rmi.RemoteException

enumerateBiomaterialsByKeyword

gov.nih.nci.cagrid.enumeration.stubs.response.EnumerationResponseContainer enumerateBiomaterialsByKeyword(BiomaterialKeywordSearchCriteria criteria)
                                                                                                          throws java.rmi.RemoteException
Throws:
java.rmi.RemoteException

enumerateHybridizations

gov.nih.nci.cagrid.enumeration.stubs.response.EnumerationResponseContainer enumerateHybridizations(HybridizationSearchCriteria criteria)
                                                                                                   throws java.rmi.RemoteException
Throws:
java.rmi.RemoteException

enumerateFiles

gov.nih.nci.cagrid.enumeration.stubs.response.EnumerationResponseContainer enumerateFiles(FileSearchCriteria criteria)
                                                                                          throws java.rmi.RemoteException
Throws:
java.rmi.RemoteException

enumerateByExample

gov.nih.nci.cagrid.enumeration.stubs.response.EnumerationResponseContainer enumerateByExample(ExampleSearchCriteria criteria)
                                                                                              throws java.rmi.RemoteException
Throws:
java.rmi.RemoteException

getMultipleResourceProperties

org.oasis.wsrf.properties.GetMultipleResourcePropertiesResponse getMultipleResourceProperties(org.oasis.wsrf.properties.GetMultipleResourceProperties_Element params)
                                                                                              throws java.rmi.RemoteException
Throws:
java.rmi.RemoteException

getResourceProperty

org.oasis.wsrf.properties.GetResourcePropertyResponse getResourceProperty(javax.xml.namespace.QName params)
                                                                          throws java.rmi.RemoteException
Throws:
java.rmi.RemoteException

queryResourceProperties

org.oasis.wsrf.properties.QueryResourcePropertiesResponse queryResourceProperties(org.oasis.wsrf.properties.QueryResourceProperties_Element params)
                                                                                  throws java.rmi.RemoteException
Throws:
java.rmi.RemoteException