Interface SiteList

All Superinterfaces:

AutoCloseable, Closeable, OsidList, OsidList

public interface SiteList
extends OsidList

Like all OsidLists , SiteList provides a means for accessing Site elements sequentially either one at a time or many at a time. Examples:

while (sl.hasNext()) {
     Site site = sl.getNextSite();
}            
  

or

while (sl.hasNext()) {
     Site[] sites = sl.getNextSites(sl.available());
}            
  

Method Summary

Modifier and Type	Method	Description
Site	getNextSite()	Gets the next Site in this list.
Site[]	getNextSites(long n)	Gets the next set of Site elements in this list which must be less than or equal to the return from available() .

Methods inherited from interface Closeable

close

Methods inherited from interface OsidList

close

Modifier and Type	Method	Description
void	close()	Close this list.

Methods inherited from interface OsidList

available, hasNext, skip

Modifier and Type	Method	Description
long	available()	Gets the number of elements available for retrieval.
boolean	hasNext()	Tests if there are more elements in this list.
void	skip(long n)	Skip the specified number of elements in the list.

Method Details

getNextSite

Site getNextSite()
          throws OperationFailedException

Gets the next Site in this list.

Returns:

the next Site in this list. The hasNext() method should be used to test that a next Site is available before calling this method.

Throws:

IllegalStateException - no more elements available in this list

OperationFailedException - unable to complete request

Compliance:

mandatory - This method must be implemented.

getNextSites

Site[] getNextSites(long n)
             throws OperationFailedException

Gets the next set of Site elements in this list which must be less than or equal to the return from available() .

Parameters:

n - the number of Site elements requested which must be less than or equal to available()

Returns:

an array of Site elements. The length of the array is less than or equal to the number specified.

Throws:

IllegalStateException - no more elements available in this list

OperationFailedException - unable to complete request

Compliance:

mandatory - This method must be implemented.