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

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

                     
                     
                     while (cl.hasNext()) {
                          Customer customer = cl.getNextCustomer();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (cl.hasNext()) {
                          Customer[] customers = cl.getNextCustomers(cl.available());
                     }
                     
                                 
                     
                
MethodgetNextCustomer
Description

Gets the next Customer in this list.

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

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

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