Interface DepotList

All Superinterfaces:

AutoCloseable, Closeable, OsidList, OsidList

public interface DepotList
extends OsidList

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

while (dl.hasNext()) {
     Depot depot = dl.getNextDepot();
}            
  

or

while (dl.hasNext()) {
     Depot[] depots = dl.getNextDepots(dl.available());
}            
  

Method Summary

Modifier and Type	Method	Description
Depot	getNextDepot()	Gets the next Depot in this list.
Depot[]	getNextDepots(long n)	Gets the next set of Depot 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

getNextDepot

Depot getNextDepot()
            throws OperationFailedException

Gets the next Depot in this list.

Returns:

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

getNextDepots

Depot[] getNextDepots(long n)
               throws OperationFailedException

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

Parameters:

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

Returns:

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