OSID Logo
OSID Specifications
billing package
Version 3.0.0
Release Candidate Preview
Interfaceosid.billing.CategoryList
Implementsosid.OsidList
Description

Like all OsidLists, CategoryList provides a means for accessing Category elements sequentially either one at a time or many at a time. Examples:

                     
                     
                     while (cl.hasNext()) {
                          Category category = cl.getNextCategory();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (cl.hasNext()) {
                          Category[] categories = cl.getNextCategories(cl.available());
                     }
                     
                                 
                     
                
MethodgetNextCategory
Description

Gets the next Category in this list.

Returnosid.billing.Categorythe next Category in this list. The hasNext() method should be used to test that a next Category is available before calling this method.
ErrorsILLEGAL_STATEno more elements available in this list
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodgetNextCategories
Description

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

Parameterscardinalnthe number of Category elements requested which must be less than or equal to available()
Returnosid.billing.Category[]an array of Category 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.