wt.pds
Interface StatementSpec

All Known Subinterfaces:

PageableSessionQuerySpec

All Known Implementing Classes:

BasicPageableQuerySpec, CompositeQuerySpec, CompoundQuerySpec, PageableQuerySpec, PagingSessionSpec, 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_ENABLED Label for the attribute; Indicates if advanced query capabilities are enabled.
static String	USE_BIND Label for the attribute; Indicates if bind parameters should be used for this statement.

Method Summary

boolean	isAdvancedQueryEnabled() Gets the value of the attribute: ADVANCED_QUERY_ENABLED.
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	setLocale(Locale a_locale) Set the client locale.
void	setUseBind(boolean a_UseBind) Sets the value of the attribute: USE_BIND.

Field Detail

ADVANCED_QUERY_ENABLED

static final String ADVANCED_QUERY_ENABLED

Label for the attribute; Indicates if advanced query capabilities are enabled. By design, this attribute is transient and its value is not passed between Java Virtual Machine (JVM) processes. The value should be set within the same JVM process that executes the statement.

Supported API: true

See Also:

Constant Field Values

USE_BIND

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

Method Detail

isAdvancedQueryEnabled

boolean isAdvancedQueryEnabled()

Gets the value of the attribute: ADVANCED_QUERY_ENABLED. Indicates if advanced query capabilities are enabled. By design, this attribute is transient and its value is not passed between Java Virtual Machine (JVM) processes. The value should be set within the same JVM process that executes the statement.

Supported API: true

Returns:

boolean

setAdvancedQueryEnabled

void setAdvancedQueryEnabled(boolean a_AdvancedQueryEnabled)

Sets the value of the attribute: ADVANCED_QUERY_ENABLED. Indicates if advanced query capabilities are enabled. By design, this attribute is transient and its value is not passed between Java Virtual Machine (JVM) processes. The value should be set within the same JVM process that executes the statement.

Supported API: true

Parameters:

a_AdvancedQueryEnabled -

isUseBind

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

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

setLocale

void setLocale(Locale a_locale)
               throws WTException

Set the client locale.

Supported API: true

Parameters:

a_locale -

Throws:

WTException