OSID Logo
OSID Specifications
mapping path package
Version 3.1.0
Interfaceosid.mapping.path.IntersectionList
Implementsosid.OsidList
Used Byosid.mapping.path.IntersectionLookupSession
osid.mapping.path.IntersectionMapSession
osid.mapping.path.IntersectionQuerySession
osid.mapping.path.IntersectionSearchResults
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.Intersection the next Intersection in this list. The hasNext() method should be used to test that a next Intersection is available before calling this method.
ErrorsILLEGAL_STATE no more elements available in this list
OPERATION_FAILED unable to complete request
Compliancemandatory This 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().

Parameterscardinaln the 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_STATE no more elements available in this list
OPERATION_FAILED unable to complete request
Compliancemandatory This method must be implemented.