org.osid.mapping.path

Interface ObstacleList

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, OsidList

public interface ObstacleList
extends OsidList

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());
       }
       
                   
       
  

Method Summary

Methods

Modifier and Type	Method and Description
Obstacle	getNextObstacle() Gets the next Obstacle in this list.
Obstacle[]	getNextObstacles(long n) Gets the next set of Obstacle elements in this list.

Methods inherited from interface org.osid.OsidList

available, hasNext, skip

Methods inherited from interface org.osid.binding.java.OsidList

close

Methods inherited from interface java.io.Closeable

close

Method Detail

getNextObstacle

Obstacle getNextObstacle()
                         throws OperationFailedException

Gets the next Obstacle in this list.

Returns:

the next Obstacle in this list. The hasNext() method should be used to test that a next Obstacle is available before calling this method.

Throws:

IllegalStateException - no more elements available in this list

OperationFailedException - unable to complete request

Compliance:

mandatory - This method must be implemented.

getNextObstacles

Obstacle[] getNextObstacles(long n)
                            throws OperationFailedException

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

Parameters:

n - the number of Obstacle elements requested which must be less than or equal to available()

Returns:

an array of Obstacle elements. The length of the array is less than or equal to the number specified.

Throws:

IllegalStateException - no more elements available in this list

OperationFailedException - unable to complete request

Compliance:

mandatory - This method must be implemented.