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

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

                     
                     
                     while (ol.hasNext()) {
                          Oubliette oubliette = ol.getNextOubliette();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (ol.hasNext()) {
                          Oubliette[] oubliettes = ol.getNextOubliettes(ol.available());
                     }
                     
                                 
                     
                
MethodgetNextOubliette
Description

Gets the next Oubliette in this list.

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

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

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