Package ch.systemsx.cisd.openbis.plugin.query.client.api.v1

Interface IQueryApiFacade

  • public interface IQueryApiFacade
    Facade for openBIS query service.

    • Method Detail

      • getSessionToken

        java.lang.String getSessionToken()
        Return the session token for the logged-in user.

      • listQueries

        java.util.List<QueryDescription> listQueries()
        Lists all queries the user has access rights.

      • executeQuery

        QueryTableModel executeQuery​(long queryID,
                             java.util.Map<java.lang.String,​java.lang.String> parameterBindings)
        Executes specified query by using specified parameter bindings.

      • listTableReportDescriptions

        java.util.List<ReportDescription> listTableReportDescriptions()
        Returns meta data for all reporting plugins which deliver a table.

      • createReportFromDataSets

        QueryTableModel createReportFromDataSets​(ReportDescription reportDescription,
                                         java.util.List<java.lang.String> dataSetCodes)
        Creates for the specified data sets and specified report description a report. Available report descriptions can be obtained by listTableReportDescriptions().

      • createReportFromDataSets

        QueryTableModel createReportFromDataSets​(java.lang.String reportKey,
                                         java.util.List<java.lang.String> dataSetCodes)
        Creates for the specified data sets and specified report key a report. It groups the data sets by a data store and creates a report for each group of objects on appropriate data store server. Results from the data stores are combined and returned as a result of this method. Available report keys can be obtained by listTableReportDescriptions().

      • listAggregationServices

        java.util.List<AggregationServiceDescription> listAggregationServices()
        List the available aggregation and ingestion services

      • createReportFromAggregationService

        QueryTableModel createReportFromAggregationService​(AggregationServiceDescription service,
                                                   java.util.Map<java.lang.String,​java.lang.Object> parameters)
        Executes the specified aggregation or ingestion service for the specified parameters and creates a report. Available service descriptions can be obtained by listAggregationServices().

      • logout

        void logout()
        Logs current user out.