OSID Logo
OSID Specifications
mapping package
Version 3.0.0
Release Candidate Preview
Interfaceosid.mapping.LocationList
Implementsosid.OsidList
Description

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

                     
                     
                     while (ll.hasNext()) {
                          Location location = ll.getNextLocation();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (ll.hasNext()) {
                          Location[] locations = ll.getNextLocations(ll.available());
                     }
                     
                                 
                     
                
MethodgetNextLocation
Description

Gets the next Location in this list.

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

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

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