com.avaje.ebeaninternal.api

Interface SpiSqlQuery

All Superinterfaces:

Serializable, SqlQuery

All Known Implementing Classes:

DefaultRelationalQuery

public interface SpiSqlQuery
extends SqlQuery

SQL query - Internal extension to SqlQuery.

Method Summary

Methods

Modifier and Type	Method and Description
int	getBackgroundFetchAfter() Return the number of rows after which background fetching occurs.
BindParams	getBindParams() Return the named or positioned parameters.
int	getBufferFetchSizeHint() Return the hint for Statement.setFetchSize().
int	getFirstRow() Return the first row to fetch.
SqlQueryListener	getListener() Return the queryListener.
String	getMapKey() Return the key property for maps.
int	getMaxRows() Return the maximum number of rows to fetch.
String	getQuery() return the query.
int	getTimeout() Return the query timeout.
boolean	isCancelled() Return true if the query has been cancelled.
boolean	isFutureFetch() Return true if this is a future fetch type query.
void	setFutureFetch(boolean futureFetch) Set to true if this is a future fetch type query.
void	setPreparedStatement(PreparedStatement pstmt) Set the PreparedStatement for the purposes of supporting cancel.

Methods inherited from interface com.avaje.ebean.SqlQuery

cancel, findFutureList, findList, findMap, findSet, findUnique, setBackgroundFetchAfter, setBufferFetchSizeHint, setFirstRow, setListener, setMapKey, setMaxRows, setParameter, setParameter, setTimeout

Method Detail

getBindParams

BindParams getBindParams()

Return the named or positioned parameters.

getQuery

String getQuery()

return the query.

getListener

SqlQueryListener getListener()

Return the queryListener.

getFirstRow

int getFirstRow()

Return the first row to fetch.

getMaxRows

int getMaxRows()

Return the maximum number of rows to fetch.

getBackgroundFetchAfter

int getBackgroundFetchAfter()

Return the number of rows after which background fetching occurs.

getMapKey

String getMapKey()

Return the key property for maps.

getTimeout

int getTimeout()

Return the query timeout.

getBufferFetchSizeHint

int getBufferFetchSizeHint()

Return the hint for Statement.setFetchSize().

isFutureFetch

boolean isFutureFetch()

Return true if this is a future fetch type query.

setFutureFetch

void setFutureFetch(boolean futureFetch)

Set to true if this is a future fetch type query.

setPreparedStatement

void setPreparedStatement(PreparedStatement pstmt)

Set the PreparedStatement for the purposes of supporting cancel.

isCancelled

boolean isCancelled()

Return true if the query has been cancelled.