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()); }
Modifier and Type | Method and 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(). |
Depot getNextDepot() throws OperationFailedException
Depot
in this list. Depot
in this list. The
hasNext()
method should be used to test that a next
Depot
is available before calling this method.IllegalStateException
- no more elements available in
this listOperationFailedException
- unable to complete requestmandatory
- This method must be implemented. Depot[] getNextDepots(long n) throws OperationFailedException
Depot
elements in this list which
must be less than or equal to the return from available().
n
- the number of Depot
elements requested which
must be less than or equal to available()
Depot
elements.
The
length of the array is less than or equal to the number
specified.IllegalStateException
- no more elements available in
this listOperationFailedException
- unable to complete requestmandatory
- This method must be implemented.