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