oracle.hsgbu.hdr.hl7.query

Interface IncrementalFetch

All Superinterfaces:

Fetch

All Known Subinterfaces:

ActFetch, ActRelationshipFetch, CoreFetch, EntityFetch, ParticipationFetch, RoleFetch

public interface IncrementalFetch
extends Fetch

Represents a fetch that can be configured to retrieve a subset of the query results according to a window of result indexes.

Incremental fetches are commonly used to render application screens that present a range of results from a potentially large result set. IncrementalFetch features are frequently used in combination with ordering of result sets.

Method Summary

Modifier and Type	Method and Description
int	getFirstFetchRowNumber() Returns the first row that will be fetched by this fetch if the retrieval window has been set, or -1 otherwise.
int	getLastFetchRowNumber() Returns the first row that will be fetched by this fetch if the retrieval window has been set, or -1 otherwise.
boolean	isIncrementalFetch() Indicates whether this fetch has been constrained with a retrieval window.
void	setRetrievalWindow(int first, int last) Sets the window of results to be retrieved.

Methods inherited from interface oracle.hsgbu.hdr.hl7.query.Fetch

equals, hashCode, isCriteriaSet, retrieveAll, retrieveNone, toString

Method Detail

setRetrievalWindow

void setRetrievalWindow(int first,
                        int last)

Sets the window of results to be retrieved. The first result is index 1.

Both ends are INCLUSIVE.

Parameters:

first - starting index

last - end index

Throws:

IllegalArgumentException - In case of invalid value

getFirstFetchRowNumber

int getFirstFetchRowNumber()

Returns the first row that will be fetched by this fetch if the retrieval window has been set, or -1 otherwise. See setRetrievalWindow for details.

Returns:

The first row to be fetched

getLastFetchRowNumber

int getLastFetchRowNumber()

Returns the first row that will be fetched by this fetch if the retrieval window has been set, or -1 otherwise. See setRetrievalWindow for details.

Returns:

The first row to be fetched

isIncrementalFetch

boolean isIncrementalFetch()

Indicates whether this fetch has been constrained with a retrieval window.

Returns:

true if setRetrievalWindow has been called successfully on this fetch.