org.duracloud.duradmin.util

Class ScrollableList<E>

java.lang.Object

org.duracloud.duradmin.util.ScrollableList<E>

All Implemented Interfaces:

Scrollable<E>

public abstract class ScrollableList<E>
extends Object
implements Scrollable<E>

Constructor Summary

Constructors

Constructor and Description
ScrollableList()

Method Summary

Methods

Modifier and Type	Method and Description
void	first()
protected abstract List<E>	getData(E currentMarker)
long	getMaxResultsPerPage() The max number of results per page; ie the page size.
List<E>	getResultList() Returns the results for the current "page"
boolean	isNextAvailable()
boolean	isPreviousAvailable()
void	markForUpdate()
void	next()
void	previous()
void	setMaxResultsPerPage(int maxResults)
protected void	update()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ScrollableList

public ScrollableList()

Method Detail

getMaxResultsPerPage

public long getMaxResultsPerPage()

Description copied from interface: Scrollable

The max number of results per page; ie the page size.

Specified by:

getMaxResultsPerPage in interface Scrollable<E>

Returns:

markForUpdate

public void markForUpdate()

setMaxResultsPerPage

public void setMaxResultsPerPage(int maxResults)

Specified by:

setMaxResultsPerPage in interface Scrollable<E>

next

public void next()

first

public void first()

Specified by:

first in interface Scrollable<E>

previous

public void previous()

Specified by:

previous in interface Scrollable<E>

isPreviousAvailable

public boolean isPreviousAvailable()

Specified by:

isPreviousAvailable in interface Scrollable<E>

isNextAvailable

public boolean isNextAvailable()

getResultList

public List<E> getResultList()

Description copied from interface: Scrollable

Returns the results for the current "page"

Specified by:

getResultList in interface Scrollable<E>

Returns:

update

protected final void update()
                     throws DataRetrievalException

Throws:

DataRetrievalException

getData

protected abstract List<E> getData(E currentMarker)
                            throws DataRetrievalException

Throws:

DataRetrievalException