OSID Logo
OSID Specifications
inventory package
Version 3.1.0
Interfaceosid.inventory.ItemList
Implementsosid.OsidList
Used Byosid.inventory.ItemLookupSession
osid.inventory.ItemQuerySession
osid.inventory.ItemSearchResults
osid.inventory.ItemWarehouseSession
Description

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());
}
                
MethodgetNextItem
Description

Gets the next Item in this list.

Returnosid.inventory.Item the next Item in this list. The hasNext() method should be used to test that a next Item is available before calling this method.
ErrorsILLEGAL_STATE no more elements available in this list
OPERATION_FAILED unable to complete request
Compliancemandatory This method must be implemented.
MethodgetNextItems
Description

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

Parameterscardinaln the number of Item elements requested which must be less than or equal to available()
Returnosid.inventory.Item[] an array of Item elements. The length of the array is less than or equal to the number specified.
ErrorsILLEGAL_STATE no more elements available in this list
OPERATION_FAILED unable to complete request
Compliancemandatory This method must be implemented.