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

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

                     
                     
                     while (ipl.hasNext()) {
                          IntersectionPath path = ipl.getNextIntersectionPath();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (ipl.hasNext()) {
                          IntersectionPath[] paths = ipl.getNextIntersectionPaths(ipl.available());
                     }
                     
                                 
                     
                
MethodgetNextIntersectionPath
Description

Gets the next IntersectionPath in this list.

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

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

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