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

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

                     
                     
                     while (rpl.hasNext()) {
                          RouteProgress progress = rpl.getNextRouteProgress();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (rpl.hasNext()) {
                          RouteProgress[] progresses = rpl.getNextRouteProgresses(rpl.available());
                     }
                     
                                 
                     
                
MethodgetNextRouteProgress
Description

Gets the next RouteProgress in this list.

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

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

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