XMLQueryOutputFormat Enumeration XMLViewService Service

Description of Services and Methods in Oracle BI EE Web Services 3-43

3.11.2 cancelQuery Method

Use this method to cancel a query and clean up resources associated with the query. This method should only be used if the query row set is not scrolled to the last row in the data set returned.

3.11.2.1 Signature

void cancelQueryString queryID, String sessionID;

3.11.3 executeSQLQuery Method

Use this method to execute a SQL query and return the results of the query.

3.11.3.1 Signature

QueryResults executeSQLQueryString sql, XMLQueryOutputFormat outputFormat, XMLQueryExecutionOptions executionOptions, String sessionID;

3.11.3.2 Returns

Returns the results of the query as one or more rows of data in a QueryResults structure for more information, see Section 2.15, QueryResults Structure .

3.11.4 executeXMLQuery Method

Use this method to execute an XML query and return the results of the query. Note: If you use this method when the query row set is scrolled to the last row in the data set returned, query data is cleaned up during the last fetchNext method invocation. Argument Description String queryID Specifies the unique ID of the query. String sessionID Specifies the unique ID of the session. Note: If the results returned exceed one page, you need to use the fetchNext Method to return the next page of rows. Argument Description String sql Specifies the string of SQL code to execute. XMLQueryOutputFormat outputFormat Specifies the output format for more information, see Section 2.31, XMLQueryExecutionOptions Structure . XMLQueryExecutionOptions executionOptions Specifies the query execution options for more information, see Section 2.31, XMLQueryExecutionOptions Structure . String sessionID Specifies the unique ID of the session. Note: If the results returned exceed one page, you need to use the fetchNext Method to return the next page of rows. 3-44 Oracle Fusion Middleware Integrators Guide for Oracle Business Intelligence Enterprise Edition

3.11.4.1 Signature

QueryResults executeXMLQueryReportRef report, XMLQueryOutputFormat outputFormat, XMLQueryExecutionOptions executionOptions, ReportParams reportParams, String sessionID;

3.11.4.2 Returns

Returns the results of the query as one or more rows of data in a QueryResults structure for more information, see Section 2.15, QueryResults Structure .

3.11.5 fetchNext Method

Use this method to return the next page of rows retrieved by a query.

3.11.5.1 Signature

QueryResults fetchNextString queryID, String sessionID;

3.11.5.2 Returns

Returns the next page of query results as one or more rows of data in a QueryResults structure for more information, see Section 2.15, QueryResults Structure . Argument Description ReportRef reportRef Specifies the analysis definition, supplied in the ReportRef common structure. XMLQueryOutputFormat outputFormat Specifies the output format for more information, see Section 2.31, XMLQueryExecutionOptions Structure . XMLQueryExecutionOptions execution Options Specifies the query execution options for more information, see Section 2.31, XMLQueryExecutionOptions Structure . ReportParams reportParams Optional. Specifies the filters or variables to apply to the analysis before execution, supplied in the ReportParams common structure. For information about the ReportParams structure, see Section 2.17, ReportParams Structure . String sessionID Specifies the unique ID of the session. Note: The page returned might contain zero rows. If the finished flag is not set, the remaining rows might not be available immediately. Argument Description String queryID Specifies the unique ID of the query, which is returned in the QueryResults object. String sessionID Specifies the unique ID of the session.