OSID Logo
OSID Specifications
financials package
Version 3.0.0
Release Candidate Preview
Interfaceosid.financials.BusinessList
Implementsosid.OsidList
Description

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

                     
                     
                     while (bl.hasNext()) {
                          Business budiness = bl.getNextBusiness();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (bl.hasNext()) {
                          Business[] businesses = bl.getNextBusinesses(bl.available());
                     }
                     
                                 
                     
                
MethodgetNextBusiness
Description

Gets the next Business in this list.

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

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

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