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

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

                     
                     
                     while (rll.hasNext()) {
                          ResourceLocation location = rll.getNextRouteResourceLocation();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (rll.hasNext()) {
                          ResourceLocation[] locations = rll.getNextResourceLocations(rll.available());
                     }
                     
                                 
                     
                
MethodgetNextResourceLocation
Description

Gets the next ResourceLocation in this list.

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

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

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