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

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

                     
                     
                     while (il.hasNext()) {
                          Intersection intersection = il.getNextIntersection();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (il.hasNext()) {
                          Intersection[] intersections = il.getNextIntersections(il.available());
                     }
                     
                                 
                     
                
MethodgetNextIntersection
Description

Gets the next Intersection in this list.

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

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

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