org.osid.mapping

Interface LocationList

All Superinterfaces:

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

public interface LocationList
extends OsidList

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

       
       
       while (ll.hasNext()) {
            Location location = ll.getNextLocation();
       }
       
                   
       
  

or

       
       
       while (ll.hasNext()) {
            Location[] locations = ll.getNextLocations(ll.available());
       }
       
                   
       
  

Method Summary

Methods

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

getNextLocation

Location getNextLocation()
                         throws OperationFailedException

Gets the next Location in this list.

Returns:

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

getNextLocations

Location[] getNextLocations(long n)
                            throws OperationFailedException

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

Parameters:

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

Returns:

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