public interface ItemList extends OsidList
Like all OsidLists,
ItemList
provides a
means for accessing Item
elements sequentially either one
at a time or many at a time. Examples:
while (il.hasNext()) { Item item = il.getNextItem(); }or
while (il.hasNext()) { Item[] items = il.getNextItems(il.available()); }
Modifier and Type | Method and Description |
---|---|
Item |
getNextItem()
Gets the next
Item in this list. |
Item[] |
getNextItems(long n)
Gets the next set of
Item elements in this list. |
Item getNextItem() throws OperationFailedException
Item
in this list. Item
in this list. The
hasNext()
method should be used to test that a next
Item
is available before calling this method.IllegalStateException
- no more elements available in
this listOperationFailedException
- unable to complete requestmandatory
- This method must be implemented. Item[] getNextItems(long n) throws OperationFailedException
Item
elements in this list. The
specified amount must be less than or equal to the return from
available().
n
- the number of Item
elements requested which
must be less than or equal to available()
Item
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.