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

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

                     
                     
                     while (bnl.hasNext()) {
                          BinNode node = bnl.getNextBinNode();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (bnl.hasNext()) {
                          BinNode[] nodes = bnl.getNextBinNodes(bnl.available());
                     }
                     
                                 
                     
                
MethodgetNextBinNode
Description

Gets the next BinNode in this list.

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

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

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