OSID Logo
OSID Specifications
room package
Version 3.1.0
Interfaceosid.room.FloorList
Implementsosid.OsidList
Used Byosid.room.FloorCampusSession
osid.room.FloorLookupSession
osid.room.FloorQuerySession
osid.room.FloorSearchResults
Description

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

while (fl.hasNext()) {
     Floor floor = fl.getNextFloor();
}
                
or
while (fl.hasNext()) {
     Floor[] floors = fl.getNextFloors(fl.available());
}
                
MethodgetNextFloor
Description

Gets the next Floor in this list.

Returnosid.room.Floor the next Floor in this list. The hasNext() method should be used to test that a next Floor 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.
MethodgetNextFloors
Description

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

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