de.innovationgate.webgate.api

Interface WGResultSetCore

All Known Subinterfaces:

WGIteratingResultSetCore, WGReportingResultSetCore

All Known Implementing Classes:

LazyBeanList, WGCachedResultSet, WGResultSetImpl

public interface WGResultSetCore

Represents the result set of a database query holding contents. To save resources, the implementation of this interface should generate only those document cores for the contents demanded.

Method Summary

Methods

Modifier and Type	Method and Description
java.util.List	getColumnNames() Returns the name of result row columns, if this query serves multi column results Result set cores not supporting this type of results should return null here
java.util.List	getContentList() Called to retrieve a list of all content in this result set.
java.util.List	getContentList(int start, int length) Called to retrieve a subset of content of this result set.
boolean	isLimitingResults() Indicates if the query type does honor result size limits, give via WGDatabase.QUERYOPTION_MAXRESULTS.
boolean	isReturnsKeys() Determines, if this result set core only returns WGContentKey-Objects, to allow the WGAPI to rely on cached document objects.
int	results() Returns the number of contents in this result set.

Method Detail

results

int results()
            throws WGBackendException

Returns the number of contents in this result set.

Returns:

long

Throws:

WGBackendException

getContentList

java.util.List getContentList(int start,
                            int length)
                              throws WGAPIException

Called to retrieve a subset of content of this result set.

Parameters:

start - Starting index of contents to be retrieved. First index is 1.

length - Number of contents to be retrieved

Returns:

List of the requested contents. Partial or empty list, if the requested position/amount exceeded the result sets size.

Throws:

WGAPIException

getContentList

java.util.List getContentList()
                              throws WGAPIException

Called to retrieve a list of all content in this result set.

Returns:

List of contents. Empty list if this result set holds no content.

Throws:

WGAPIException

isReturnsKeys

boolean isReturnsKeys()

Determines, if this result set core only returns WGContentKey-Objects, to allow the WGAPI to rely on cached document objects. If false, this result set core is expected to return WGDocumentCore objects.

isLimitingResults

boolean isLimitingResults()

Indicates if the query type does honor result size limits, give via WGDatabase.QUERYOPTION_MAXRESULTS. False means that the result set does not limit itself, and the limit must be enforced by WGA.

getColumnNames

java.util.List getColumnNames()
                              throws WGAPIException

Returns the name of result row columns, if this query serves multi column results Result set cores not supporting this type of results should return null here

Throws:

WGAPIException