OSID Logo
OSID Specifications
room package
Version 3.0.0
Release Candidate Preview
Interfaceosid.room.RoomList
Implementsosid.OsidList
Description

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

                     
                     
                     while (rl.hasNext()) {
                          Room room = rl.getNextRoom();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (rl.hasNext()) {
                          Room[] rooms = rl.getNextRooms(rl.available());
                     }
                     
                                 
                     
                
MethodgetNextRoom
Description

Gets the next Room in this list.

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

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

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