wt.pds
Interface ResultCursor

All Known Implementing Classes:

BasicResultCursor, ObjectReferenceCursor, RangeResultCursor

public interface ResultCursor

This class encapsulates functionality for accessing the rows from a query. This is a logical cursor that can span more than one statement.

A reference to a StatementBuilder and Connection are maintained so that SQL statements can be executed as needed. The ResultCursor is not responsible for initially building the SQL statements or maintaining the connection. The ResultCursor only encapsulates an algorithm for traversing a result set and is not responsible for building the SQL or maintaining the connection.

Supported API: false

Extendable: false

Field Summary

static String	CONNECTION Label for the attribute.
static String	COUNT Label for the attribute; Total number of rows that were traversed (not necessarily returned results).
static String	QUERY_LIMIT Label for the attribute.
static String	RESET Label for the attribute; Indicates if the result cursor has been reset.
static String	RESULT_BUILDER Label for the attribute.
static String	STATEMENT_BUILDER Label for the attribute.

Method Summary

boolean	advance(int a_relative) Advances the ResultCursor the relative number of rows without result processing.
void	close() Ensures that any associated result sets and/or statements are closed.
WTConnection	getConnection() Gets the value of the attribute: CONNECTION.
int	getCount() Gets the value of the attribute: COUNT.
int	getQueryLimit() Gets the value of the attribute: QUERY_LIMIT.
ResultBuilder	getResultBuilder() Gets the object for the association that plays role: RESULT_BUILDER.
StatementBuilder	getStatementBuilder() Gets the object for the association that plays role: STATEMENT_BUILDER.
boolean	isReset() Gets the value of the attribute: RESET.
Object[]	next(AccessController a_accessController) Advance to the next valid row in the result set and returned the built objects.
void	setConnection(WTConnection a_Connection) Sets the value of the attribute: CONNECTION.
void	setReset(boolean a_Reset) Sets the value of the attribute: RESET.
void	setResultBuilder(ResultBuilder a_ResultBuilder) Sets the object for the association that plays role: RESULT_BUILDER.
void	setStatementBuilder(StatementBuilder a_StatementBuilder) Sets the object for the association that plays role: STATEMENT_BUILDER.

Field Detail

RESET

public static final String RESET

Label for the attribute; Indicates if the result cursor has been reset.

Supported API: false

See Also:

Constant Field Values

CONNECTION

public static final String CONNECTION

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

COUNT

public static final String COUNT

Label for the attribute; Total number of rows that were traversed (not necessarily returned results).

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

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

Method Detail

isReset

public boolean isReset()

Gets the value of the attribute: RESET. Indicates if the result cursor has been reset.

Supported API: false

Returns:

boolean

setReset

public void setReset(boolean a_Reset)
              throws WTPropertyVetoException

Sets the value of the attribute: RESET. Indicates if the result cursor has been reset.

Supported API: false

Parameters:

a_Reset -

Throws:

WTPropertyVetoException

getConnection

public WTConnection getConnection()

Gets the value of the attribute: CONNECTION.

Supported API: false

Returns:

WTConnection

setConnection

public void setConnection(WTConnection a_Connection)
                   throws WTPropertyVetoException

Sets the value of the attribute: CONNECTION.

Supported API: false

Parameters:

a_Connection -

Throws:

WTPropertyVetoException

getCount

public int getCount()

Gets the value of the attribute: COUNT. Total number of rows that were traversed (not necessarily returned results).

Supported API: false

Returns:

int

getQueryLimit

public int getQueryLimit()

Gets the value of the attribute: QUERY_LIMIT.

Supported API: false

Returns:

int

getStatementBuilder

public StatementBuilder getStatementBuilder()

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

Supported API: false

Returns:

StatementBuilder

setStatementBuilder

public void setStatementBuilder(StatementBuilder a_StatementBuilder)
                         throws WTPropertyVetoException

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

Supported API: false

Parameters:

a_StatementBuilder -

Throws:

WTPropertyVetoException

getResultBuilder

public ResultBuilder getResultBuilder()

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

Supported API: false

Returns:

ResultBuilder

setResultBuilder

public void setResultBuilder(ResultBuilder a_ResultBuilder)
                      throws WTPropertyVetoException

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

Supported API: false

Parameters:

a_ResultBuilder -

Throws:

WTPropertyVetoException

next

public Object[] next(AccessController a_accessController)
              throws PersistenceException

Advance to the next valid row in the result set and returned the built objects.

Supported API: false

Parameters:

a_accessController -

Returns:

Object[]

Throws:

PersistenceException

close

public void close()

Ensures that any associated result sets and/or statements are closed.

Supported API: false

advance

public boolean advance(int a_relative)
                throws PersistenceException

Advances the ResultCursor the relative number of rows without result processing.

Supported API: false

Parameters:

a_relative -

Returns:

boolean

Throws:

PersistenceException