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

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

                     
                     
                     while (pl.hasNext()) {
                          Path path = pl.getNextPath();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (pl.hasNext()) {
                          Path[] paths = pl.getNextPaths(pl.available());
                     }
                     
                                 
                     
                
MethodgetNextPath
Description

Gets the next Path in this list.

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

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

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