OSID Logo
OSID Specifications
hold package
Version 3.1.0
Interfaceosid.hold.BlockList
Implementsosid.OsidList
Used Byosid.hold.BlockLookupSession
osid.hold.BlockOublietteSession
osid.hold.BlockQuerySession
osid.hold.BlockSearchResults
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.Block the next Block in this list. The hasNext() method should be used to test that a next Block 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.
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().

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