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

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

                     
                     
                     while (ol.hasNext()) {
                          Obstacle obstacle = ol.getNextObstacle();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (ol.hasNext()) {
                          Obstacle[] obstacles = ol.getNextObstacles(ol.available());
                     }
                     
                                 
                     
                
MethodgetNextObstacle
Description

Gets the next Obstacle in this list.

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

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

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