org.shept.persistence.provider
Interface ScrollingListProvider

All Known Implementing Classes:

AbstractHibernateListProvider, AbstractScrollingListProvider, HibernateAssociationProvider, HibernateCriteriaListProviderImpl, HibernateExampleListProviderImpl, HibernateQueryListProviderImpl

public interface ScrollingListProvider

The ScrollingListProvider interface provides an interface to scroll the results of a datasource provider.

Version:

%version 1.0%

Author:

Andi

Method Summary

org.springframework.dao.support.DaoSupport	getDao()
FilterDefinition	getFilterDefinition()
int	getLoadSize()
org.springframework.beans.support.SortDefinition	getSortDefinition()
boolean	isEol()
List<?>	loadListFirst() Read the first chunk of elements from the underlying datasource.
List<?>	loadListNext() Read a subsequent portion of elements from the underlying datasource
void	setDao(org.springframework.dao.support.DaoSupport dao) Set the data access object which depends on the persistence layer in use
void	setFilterDefinition(FilterDefinition filterDefinition)
void	setLoadSize(int page) set the load size which will be used for paging
void	setSortDefinition(org.springframework.beans.support.SortDefinition sortDefinition)

Method Detail

loadListFirst

List<?> loadListFirst()

Read the first chunk of elements from the underlying datasource.

Returns:

the resulting list of elements

loadListNext

List<?> loadListNext()

Read a subsequent portion of elements from the underlying datasource

Returns:

the resulting list of elements

isEol

boolean isEol()

Returns:

true if end-of-lines is reached (no further results available)

getDao

org.springframework.dao.support.DaoSupport getDao()

Returns:

the data access object which depends on the persistence layer in use

setDao

void setDao(org.springframework.dao.support.DaoSupport dao)

Set the data access object which depends on the persistence layer in use

getLoadSize

int getLoadSize()

Returns:

Number of records to read from the database initially and subsequently (if paging is supported)

setLoadSize

void setLoadSize(int page)

set the load size which will be used for paging

getSortDefinition

org.springframework.beans.support.SortDefinition getSortDefinition()

setSortDefinition

void setSortDefinition(org.springframework.beans.support.SortDefinition sortDefinition)

getFilterDefinition

FilterDefinition getFilterDefinition()

Parameters:

-

Returns:

setFilterDefinition

void setFilterDefinition(FilterDefinition filterDefinition)

Parameters:

-

filterDefinition -