OSID Logo
OSID Specifications
room package
Version 3.1.0
Interfaceosid.room.BuildingList
Implementsosid.OsidList
Used Byosid.room.Building
osid.room.BuildingCampusSession
osid.room.BuildingLookupSession
osid.room.BuildingQuerySession
osid.room.BuildingSearchResults
Description

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

while (bl.hasNext()) {
     Building building = bl.getNextBuilding();
}
                
or
while (bl.hasNext()) {
     Building[] buildings = bl.getNextBuildings(bl.available());
}
                
MethodgetNextBuilding
Description

Gets the next Building in this list.

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

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

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