flex.messaging.io
Interface PageableRowSet

All Known Implementing Classes:

PagedRowSet

public interface PageableRowSet

Implementations of this class are recoginized by the serialization filter as result sets that are pageable. A pageable result set is a server side cache of a query result (that implements java.sql.ResultSet) and is typically stored in the session object. Users can request a subset of data from the object given that they know it's id.

See Also:

RowSet

Field Summary

static String	CURSOR
static String	PAGE Constants for getRecords map keys.

Method Summary

String[]	getColumnNames() List the column names of the result set.
String	getID()
int	getInitialDownloadCount() If this function returns a number >= the total number of records in the recordset, then the recordset should be simply returned to the client in full.
Map	getRecords(int startIndex, int count) Use this method to get a subset of records.
int	getRowCount()
String	getServiceName()
void	setServicename(String serviceName)

Field Detail

PAGE

static final String PAGE

Constants for getRecords map keys.

See Also:

Constant Field Values

CURSOR

static final String CURSOR

See Also:

Constant Field Values

Method Detail

getColumnNames

String[] getColumnNames()
                        throws SQLException

List the column names of the result set.

Returns:

String[] An array of the column names as strings, as ordered by the result set provider's column number assignment.

Throws:

SQLException

getRecords

Map getRecords(int startIndex,
               int count)
               throws SQLException

Use this method to get a subset of records. A map is returned with two fields, the first being the row number the data page started from, and the second being the array of arrays for the actual data page.

Returns:

Map Contains two fields, the page's row index and the actual data array.

Throws:

SQLException

getRowCount

int getRowCount()

Returns:

int The total number of rows in the result set.

getInitialDownloadCount

int getInitialDownloadCount()

If this function returns a number >= the total number of records in the recordset, then the recordset should be simply returned to the client in full. However, if it is < the total size, then this object itself is saved in Session data, and tagged with a unique ID.

getID

String getID()

Returns:

String This paged result's (universally unique) id.

getServiceName

String getServiceName()

Returns:

String The name of the service that will manage this paged result.

setServicename

void setServicename(String serviceName)

Parameters:

serviceName - Update the name of the service that manages the pages for this query.