com.sapportals.connector.execution.objects

Interface IAbstractQuery

All Known Subinterfaces:
INativeQuery, IQuery

public interface IAbstractQuery

The abstract interface for query


Method Summary
 void cancel()
          Cancels the query if it is asynchronous
 int retrieveQueryChunkSize()
          Returns the maximum rows number in a RecordSet that is received as a return value of the retrieveResultSet() method.
 int retrieveQueryTimeOut()
          Returns the maximum time to execute the query.
 void setQueryChunkSize(int chunkSize)
          Sets the maximum rows number in a RecordSet that is received as a return value of the retrieveResultSet() method.
 void setQueryTimeOut(int msTimeOut)
          Sets the maximum time to execute the query.
 

Method Detail

cancel

void cancel()
            throws ConnectorException
Cancels the query if it is asynchronous

Throws:
ConnectorException

setQueryTimeOut

void setQueryTimeOut(int msTimeOut)
Sets the maximum time to execute the query.

Parameters:
msTimeOut - the time to wait in milliseconds

retrieveQueryTimeOut

int retrieveQueryTimeOut()
Returns the maximum time to execute the query.

Returns:
the time to wait in milliseconds

setQueryChunkSize

void setQueryChunkSize(int chunkSize)
Sets the maximum rows number in a RecordSet that is received as a return value of the retrieveResultSet() method. The result of an execution of a query is a record set. In order to be able to control the number of rows that are retrieved from the query result, set the chunk size to that number of rows, and use the next() method to move to the next chunk.

Parameters:
chunkSize - the number of rows for each record set chunk

retrieveQueryChunkSize

int retrieveQueryChunkSize()
Returns the maximum rows number in a RecordSet that is received as a return value of the retrieveResultSet() method.

Returns:
int the number of rows for each result set chunk
Access Rights

This class can be accessed from:


SC DC Public Part ACH
[sap.com] EP-BASIS-API [sap.com] tc/epbc/connectivityfw/api api EP-PIN
[sap.com] FRAMEWORK-EXT [sap.com] tc/conn/connectorframeworkdeprecated - EP-CON-CF
[sap.com] FRAMEWORK-EXT [sap.com] tc/conn/connectorframeworkdeprecated default EP-CON-CF


Copyright 2015 SAP AG Complete Copyright Notice