Interface StoreList

All Superinterfaces:

AutoCloseable, Closeable, OsidList, OsidList

public interface StoreList
extends OsidList

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

while (sl.hasNext()) {
     Store store = sl.getNextStore();
}            
  

or

while (sl.hasNext()) {
     Store[] stores = sl.getNextStores(sl.available());
}            
  

Method Summary

Modifier and Type	Method	Description
Store	getNextStore()	Gets the next Store in this list.
Store[]	getNextStores(long n)	Gets the next set of Store elements in this list.

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

getNextStore

Store getNextStore()
            throws OperationFailedException

Gets the next Store in this list.

Returns:

the next Store in this list. The hasNext() method should be used to test that a next Store 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.

getNextStores

Store[] getNextStores(long n)
               throws OperationFailedException

Gets the next set of Store elements in this list. The specified amount must be less than or equal to the return from available() .

Parameters:

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

Returns:

an array of Store 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.