org.osid.mapping.route

Interface RouteProgressList

All Superinterfaces:

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

public interface RouteProgressList
extends OsidList

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

       
       
       while (rpl.hasNext()) {
            RouteProgress progress = rpl.getNextRouteProgress();
       }
       
                   
       
  

or

       
       
       while (rpl.hasNext()) {
            RouteProgress[] progresses = rpl.getNextRouteProgresses(rpl.available());
       }
       
                   
       
  

Method Summary

Methods

Modifier and Type	Method and Description
RouteProgress	getNextRouteProgress() Gets the next RouteProgress in this list.
RouteProgress[]	getNextRouteProgresses(long n) Gets the next set of RouteProgress 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

getNextRouteProgress

RouteProgress getNextRouteProgress()
                                   throws OperationFailedException

Gets the next RouteProgress in this list.

Returns:

the next RouteProgress in this list. The hasNext() method should be used to test that a next RouteProgress 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.

getNextRouteProgresses

RouteProgress[] getNextRouteProgresses(long n)
                                       throws OperationFailedException

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

Parameters:

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

Returns:

an array of RouteProgress 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.