OSID Logo
OSID Specifications
resource package
Version 3.1.0
Interfaceosid.resource.BinList
Implementsosid.OsidList
Used Byosid.resource.BinHierarchySession
osid.resource.BinLookupSession
osid.resource.BinQuerySession
osid.resource.BinSearchResults
osid.resource.ResourceBinSession
osid.resource.ResourceRelationshipBinSession
osid.resource.demographic.DemographicBinSession
osid.resource.demographic.DemographicEnablerBinSession
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.Bin the next Bin in this list. The hasNext() method should be used to test that a next Bin is available before calling this method.
ErrorsILLEGAL_STATE no more elements available in this list
OPERATION_FAILED unable to complete request
Compliancemandatory This 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().

Parameterscardinaln the 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_STATE no more elements available in this list
OPERATION_FAILED unable to complete request
Compliancemandatory This method must be implemented.