Skip navigation links

com.stellent.cis.client.api.common.search
Interface ICISResultIterator

All Superinterfaces:

java.util.Iterator

public interface ICISResultIterator

extends java.util.Iterator

Method Summary

int	getCurrentIndex()
int	getCurrentPage()
int	getCurrentPageSize()
int	getPageSize()
java.util.List	getResultList()
int	getTotalPages()
int	getTotalResults()
boolean	hasNext()
boolean	isCanPageBackward()
boolean	isCanPageForward()
void	moveTo(int pageNumber)
ICISContent	nextContent()
void	pageBackward() Moves the pointer in the result set backward a page.
void	pageForward() Moves the pointer in the result set forward a page.

Methods inherited from interface java.util.Iterator

next, remove

Method Detail

hasNext

boolean hasNext()

Specified by:

hasNext in interface java.util.Iterator

Returns:

Whether or not there are more results left in current page.

nextContent

ICISContent nextContent()

Returns:

Returns the next result in the list if available. ICISContent

pageForward

void pageForward()

Moves the pointer in the result set forward a page.

isCanPageForward

boolean isCanPageForward()

Returns:

Whether or not this iterator can page forward.

pageBackward

void pageBackward()

Moves the pointer in the result set backward a page.

isCanPageBackward

boolean isCanPageBackward()

Returns:

Whether or not this iterator can page backward.

moveTo

void moveTo(int pageNumber)

Parameters:

pageNumber - The page to move the result set pointer to.

getPageSize

int getPageSize()

Returns:

The page size this iterator uses.

getCurrentPageSize

int getCurrentPageSize()

Returns:

The number of results available in the current page.

getTotalPages

int getTotalPages()

Returns:

The total number of pages available.

getTotalResults

int getTotalResults()

Returns:

The total number of individual results.

getCurrentPage

int getCurrentPage()

Returns:

The current page the iterator is on.

getResultList

java.util.List getResultList()

Returns:

The list of results this iterator is based on.

getCurrentIndex

int getCurrentIndex()

Returns:

The current index in the list.

Skip navigation links