OSID Logo
OSID Specifications
resource package
Version 3.0.0
Release Candidate Preview
Interfaceosid.resource.BinList
Implementsosid.OsidList
Description

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

                     
                     
                     while (bl.hasNext()) {
                          Bin bin = bl.getNextBin();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (bl.hasNext()) {
                          Bin[] bins = bl.getNextBins(bl.available());
                     }
                     
                                 
                     
                
MethodgetNextBin
Description

Gets the next Bin in this list.

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

Gets the next set of Bin elements in this list which must be less than or equal to the return from available().

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