de.innovationgate.webgate.api

Interface WGResultSet

All Known Implementing Classes:

WGAbstractResultSet, WGStandardResultSet

public interface WGResultSet

Generic interface for result sets that are returned by the WGAPI. The WGResultSet implementation should: - Filter out contents based on the fields "validfrom" and "validto" if the query option "enhanced" is either omitted or set to true - Filter out contents based on the field "visible", if the query option "enhanced" is either omitted or set to true

Method Summary

Methods

Modifier and Type	Method and Description
WGContentList	getContentList() Called to retrieve a list of all content in this result set.
WGContentList	getContentList(int start, int length) Called to retrieve a subset of content of this result set.
long	getExecutionTime() This method may return the execution time of the backend query in milliseconds.
de.innovationgate.utils.SkippingIterator<WGContent>	getResultIterator() Returns an iterator iterating over the results
boolean	hasResults() Indicates if the result set contains any results
boolean	isLimitingResultsInBackend() Indicates if the query type does honor result size limits, give via WGDatabase.QUERYOPTION_MAXRESULTS.
void	limitResults(int limit) Call to limit the results to return to the given count.
int	results() Number of results that are in this results set.

Method Detail

results

int results()
            throws WGBackendException

Number of results that are in this results set.

Throws:

WGBackendException

hasResults

boolean hasResults()
                   throws WGBackendException

Indicates if the result set contains any results

Throws:

WGBackendException

getContentList

WGContentList 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

WGContentList 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

getResultIterator

de.innovationgate.utils.SkippingIterator<WGContent> getResultIterator()
                                                                      throws WGAPIException

Returns an iterator iterating over the results

Throws:

WGAPIException

limitResults

void limitResults(int limit)
                  throws WGBackendException

Call to limit the results to return to the given count. The resultset will only return results to this number. If the available results are fewer than this number this call has no effect.

Parameters:

limit - Maximum number of results to return.

Throws:

WGBackendException

getExecutionTime

long getExecutionTime()

This method may return the execution time of the backend query in milliseconds. Returns 0 if not supported.

isLimitingResultsInBackend

boolean isLimitingResultsInBackend()

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 (for example via limitResults(int)