OSID Logo
OSID Specifications
billing package
Version 3.0.0
Release Candidate Preview
Interfaceosid.billing.ItemList
Implementsosid.OsidList
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 unit = il.getNextItem();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (il.hasNext()) {
                          Item[] units = il.getNextItems(il.available());
                     }
                     
                                 
                     
                
MethodgetNextItem
Description

Gets the next Item in this list.

Returnosid.billing.Itemthe next Item in this list. The hasNext() method should be used to test that a next Item is available before calling this method.
ErrorsILLEGAL_STATEno more elements available in this list
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis 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().

Parameterscardinalnthe number of Item elements requested which must be less than or equal to available()
Returnosid.billing.Item[]an array of Item elements. The length of the array is less than or equal to the number specified.
ErrorsILLEGAL_STATEno more elements available in this list
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.