wt.pds
Interface StatementSpec

All Known Subinterfaces:

PageableSessionQuerySpec

All Known Implementing Classes:

BasicPageableQuerySpec, CompositeQuerySpec, CompoundQuerySpec, InflateSpec, PageableQuerySpec, QuerySpec

public interface StatementSpec

This class defines an abstraction for a SQL statement query. It aggregates several "helper" objects that provide the algorithms necessary to implement the query.

The primaryClass attribute is for compatibility with the POM which uses a target class to determine the PDS to use. The singleResultCompatible attribute is used to maintain backward compatibility with code that assumes a single class query will contain a single Persistable element in the result set.

Supported API: true

Extendable: false

Field Summary

static String	ADVANCED_QUERY Label for the attribute; Indicates if the statement uses advanced query capabilities.
static String	ADVANCED_QUERY_ENABLED Label for the attribute; Indicates if advanced query capabilities are enabled.
static String	AGGREGATE_SELECT Label for the attribute; Indicates if the statement has aggregate select .
static String	CORRELATED_CLASS_ATTRIBUTES Label for the attribute.
static String	FETCH_SIZE Label for the attribute; A hint as to the number of rows that should be fetched from the database when more rows are needed.
static String	PRIMARY_CLASS Label for the attribute; Primary class for the query.
static String	QUERY_LIMIT Label for the attribute.
static String	RESULT_BUILDER Label for the attribute.
static String	RESULT_CURSOR Label for the attribute.
static String	SINGLE_RESULT_COMPATIBLE Label for the attribute; Indicates if the query result should be returned as a single result (for backward compatibility) Supported API: false
static String	STATEMENT_BUILDER Label for the attribute.
static String	USE_BIND Label for the attribute; Indicates if bind parameters should be used for this statement.

Method Summary

int	getBindParameterCount() Supported API: false
List	getCorrelatedClassAttributes() Gets the value of the attribute: CORRELATED_CLASS_ATTRIBUTES.
int	getFetchSize() Gets the value of the attribute: FETCH_SIZE.
Class	getPrimaryClass() Gets the value of the attribute: PRIMARY_CLASS.
int	getQueryLimit() Gets the value of the attribute: QUERY_LIMIT.
ResultBuilder	getResultBuilder() Gets the object for the association that plays role: RESULT_BUILDER.
ResultCursor	getResultCursor() Gets the object for the association that plays role: RESULT_CURSOR.
StatementBuilder	getStatementBuilder() Gets the object for the association that plays role: STATEMENT_BUILDER.
boolean	isAdvancedQuery() Gets the value of the attribute: ADVANCED_QUERY.
boolean	isAdvancedQueryEnabled() Gets the value of the attribute: ADVANCED_QUERY_ENABLED.
boolean	isAggregateSelect() Gets the value of the attribute: AGGREGATE_SELECT.
boolean	isSingleResultCompatible() Gets the value of the attribute: SINGLE_RESULT_COMPATIBLE.
boolean	isUseBind() Gets the value of the attribute: USE_BIND.
void	setAdvancedQueryEnabled(boolean a_AdvancedQueryEnabled) Sets the value of the attribute: ADVANCED_QUERY_ENABLED.
void	setBindParameterAt(Object a_value, int a_index) Supported API: false
void	setFetchSize(int a_FetchSize) Sets the value of the attribute: FETCH_SIZE.
void	setLocale(Locale a_locale) Set the client locale.
void	setUseBind(boolean a_UseBind) Sets the value of the attribute: USE_BIND.

Field Detail

PRIMARY_CLASS

public static final String PRIMARY_CLASS

Label for the attribute; Primary class for the query.

Supported API: false

See Also:

Constant Field Values

SINGLE_RESULT_COMPATIBLE

public static final String SINGLE_RESULT_COMPATIBLE

Label for the attribute; Indicates if the query result should be returned as a single result (for backward compatibility)

Supported API: false

See Also:

Constant Field Values

QUERY_LIMIT

public static final String QUERY_LIMIT

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

ADVANCED_QUERY_ENABLED

public static final String ADVANCED_QUERY_ENABLED

Label for the attribute; Indicates if advanced query capabilities are enabled.

Supported API: true

See Also:

Constant Field Values

ADVANCED_QUERY

public static final String ADVANCED_QUERY

Label for the attribute; Indicates if the statement uses advanced query capabilities.

Supported API: false

See Also:

Constant Field Values

AGGREGATE_SELECT

public static final String AGGREGATE_SELECT

Label for the attribute; Indicates if the statement has aggregate select .

Supported API: false

See Also:

Constant Field Values

CORRELATED_CLASS_ATTRIBUTES

public static final String CORRELATED_CLASS_ATTRIBUTES

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

USE_BIND

public static final String USE_BIND

Label for the attribute; Indicates if bind parameters should be used for this statement.

Supported API: true

See Also:

Constant Field Values

FETCH_SIZE

public static final String FETCH_SIZE

Label for the attribute; A hint as to the number of rows that should be fetched from the database when more rows are needed.

Supported API: false

See Also:

Constant Field Values

STATEMENT_BUILDER

public static final String STATEMENT_BUILDER

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

RESULT_BUILDER

public static final String RESULT_BUILDER

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

RESULT_CURSOR

public static final String RESULT_CURSOR

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

Method Detail

getPrimaryClass

public Class getPrimaryClass()

Gets the value of the attribute: PRIMARY_CLASS. Primary class for the query.

Supported API: false

Returns:

Class

isSingleResultCompatible

public boolean isSingleResultCompatible()

Gets the value of the attribute: SINGLE_RESULT_COMPATIBLE. Indicates if the query result should be returned as a single result (for backward compatibility)

Supported API: false

Returns:

boolean

getQueryLimit

public int getQueryLimit()

Gets the value of the attribute: QUERY_LIMIT.

Supported API: false

Returns:

int

isAdvancedQueryEnabled

public boolean isAdvancedQueryEnabled()

Gets the value of the attribute: ADVANCED_QUERY_ENABLED. Indicates if advanced query capabilities are enabled.

Supported API: true

Returns:

boolean

setAdvancedQueryEnabled

public void setAdvancedQueryEnabled(boolean a_AdvancedQueryEnabled)

Sets the value of the attribute: ADVANCED_QUERY_ENABLED. Indicates if advanced query capabilities are enabled.

Supported API: true

Parameters:

a_AdvancedQueryEnabled -

isAdvancedQuery

public boolean isAdvancedQuery()
                        throws WTException

Gets the value of the attribute: ADVANCED_QUERY. Indicates if the statement uses advanced query capabilities.

Supported API: false

Returns:

boolean

Throws:

WTException

isAggregateSelect

public boolean isAggregateSelect()

Gets the value of the attribute: AGGREGATE_SELECT. Indicates if the statement has aggregate select .

Supported API: false

Returns:

boolean

getCorrelatedClassAttributes

public List getCorrelatedClassAttributes()

Gets the value of the attribute: CORRELATED_CLASS_ATTRIBUTES.

Supported API: false

Returns:

List

isUseBind

public boolean isUseBind()

Gets the value of the attribute: USE_BIND. Indicates if bind parameters should be used for this statement.

Supported API: true

Returns:

boolean

setUseBind

public void setUseBind(boolean a_UseBind)
                throws WTPropertyVetoException

Sets the value of the attribute: USE_BIND. Indicates if bind parameters should be used for this statement.

Supported API: true

Parameters:

a_UseBind -

Throws:

WTPropertyVetoException

getFetchSize

public int getFetchSize()

Gets the value of the attribute: FETCH_SIZE. A hint as to the number of rows that should be fetched from the database when more rows are needed.

Supported API: false

Returns:

int

setFetchSize

public void setFetchSize(int a_FetchSize)
                  throws WTPropertyVetoException

Sets the value of the attribute: FETCH_SIZE. A hint as to the number of rows that should be fetched from the database when more rows are needed.

Supported API: false

Parameters:

a_FetchSize -

Throws:

WTPropertyVetoException

getStatementBuilder

public StatementBuilder getStatementBuilder()

Gets the object for the association that plays role: STATEMENT_BUILDER.

Supported API: false

Returns:

StatementBuilder

getResultBuilder

public ResultBuilder getResultBuilder()

Gets the object for the association that plays role: RESULT_BUILDER.

Supported API: false

Returns:

ResultBuilder

getResultCursor

public ResultCursor getResultCursor()

Gets the object for the association that plays role: RESULT_CURSOR.

Supported API: false

Returns:

ResultCursor

setLocale

public void setLocale(Locale a_locale)
               throws WTException

Set the client locale.

Supported API: true

Parameters:

a_locale -

Throws:

WTException

setBindParameterAt

public void setBindParameterAt(Object a_value,
                               int a_index)

Supported API: false

Parameters:

a_value -

a_index -

getBindParameterCount

public int getBindParameterCount()

Supported API: false

Returns:

int