OSID Logo
OSID Specifications
hold package
Version 3.0.0
Release Candidate Preview
Interfaceosid.hold.BlockList
Implementsosid.OsidList
Description

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

                     
                     
                     while (bl.hasNext()) {
                          Block block = bl.getNextBlock();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (bl.hasNext()) {
                          Block[] blocks = bl.getNextBlocks(bl.available());
                     }
                     
                                 
                     
                
MethodgetNextBlock
Description

Gets the next Block in this list.

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

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

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